No description, website, or topics provided.
JavaScript Shell HTML Ruby
Pull request Compare This branch is 297 commits behind appcelerator:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
add-ons
jsduck2json
landing
meta
resources
.gitignore
README.md
build_21.sh
build_30.sh
build_platform.sh
clouddeploy.sh
copy_21.sh
copy_30.sh
copy_cloud.sh
copy_platform.sh
deploy.sh
guides_parser.js
guides_wiki_whitelist
jsduck.config
jsduck2json.sh
jsduck_cloud.config
jsduck_static.config
package.json
repo_update.sh
repo_update_jenkins.sh
videos.json
welcome.html

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.