Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript Shell HTML Ruby
Branch: master
Failed to load latest commit information.
add-ons Created Alloy add-on docs to include Github edit urls.
jsduck2json Adios, Python
landing Initial checkin of documentation tools for generating Ti docs with Js…
meta Window support
resources Initial checkin of documentation tools for generating Ti docs with Js…
.gitignore Added options for building with Alloy. Note that only the "debug" bui…
README.md Update README
build_21.sh TIDOC-1138 Tooling updates for 360
build_30.sh Revert change
build_platform.sh [TIDOC-2168] Port guide_parser to JS and update build files
clouddeploy.sh [TIDOC-2217] Port Python Scripts to JS
copy_21.sh Adding sample scripts for building & copying files for doc site.
copy_30.sh Generate Solr content when building for production. Add HTTPS module …
copy_cloud.sh [TIDOC-2168] Port guide_parser to JS and update build files
copy_platform.sh
deploy.sh [TIDOC-2217] Port Python Scripts to JS
guides_parser.js Fix link
guides_wiki_whitelist Initial checkin of doc tooling files.
jsduck.config Fix link
jsduck2json.sh [TIDOC-2217] Port Python Scripts to JS
jsduck_cloud.config Updates
jsduck_static.config Updates
package.json [TIDOC-2217] Port Python Scripts to JS
repo_update.sh Update SOLR command
repo_update_jenkins.sh Window Support for Jenkins
videos.json [TIDOC-1731] Update video content
welcome.html Initial checkin of doc tooling files.

README.md

DocTools

This repository contains build scripts, configuration files, and other miscellany related to building the Titanium docs for JsDuck.

To build the docs, you must have a local clone of this repo, the titanium_mobile repo, and the Titanium-flavored JsDuck repo.

Initial Setup

  1. Clone all three repos, preferably into the same parent folder (for example, ~/work).

  2. Set the TI_ROOT environment variable to the parent directory of all three repos.

    TI_ROOT=~/work export TI_ROOT

    If the repos are in different locations, or use non-default names, you can set environment variables for each repo. See deploy.sh.

  3. Make sure you have Ruby 1.9.2 or greater installed, and install JsDuck's dependencies:

    gem install rdiscount
    gem install rspec
    gem install json
    gem install parallel
    gem install compass
    gem install execjs
    gem install dimensions
    
  4. Install npm dependencies:

    npm install .
    
  5. If using Mavericks (OS X 10.9 or greater), install the Xcode command-line tools:

    sudo xcode-select --install
    
  6. Export the wiki docs as an Eclise Help archive. Extract the archive and rename the folder to ${DOCTOOLS_DIR}/htmlguides.

  7. Here goes nothing! Try building the docs:

    sh deploy.sh
    
  8. If all goes well, open dist/platform/latest/index.html and see how it looks.

Something went wrong with that request. Please try again.