Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.17 KB

README.md

File metadata and controls

67 lines (42 loc) · 2.17 KB
Raw

MontageJS & Montage Studio Docs

Contributing

For contribution to non-API MontageJS docs & Montage Studio docs, please submit a PR against a .md file in this repo.

For contribution to MontageJS API docs, please submit a PR against MontageJS repo using JSDoc.

Setting up Local Jekyll Environment

The docs site uses Jekyll and is automatically built/deployed via GitHub Pages.

First you need Ruby >= 2.0.0, RubyGems (comes with Ruby >= 1.9) and Bundler. Once installed, clone this repo then run bundle install in repo directory. This will get you a local environment in sync with GitHub Pages' dependencies.

Now run bundle exec jekyll serve, then browse to http://localhost:4000. Changed files will be automatically watched and rebuilt. You can close the server with Ctrl c.

Building MontageJS API Docs

TODO: Update README _build script since the home example and apps are not part of this repo anymore. Only the API.

First install the build dependencies:

$ cd _build
$ npm install
$ cd ..

The apps, API docs and home example can all be built individually:

$ _build/build.js apps
$ _build/build.js api
$ _build/build.js home

or several at the same time:

$ _build/build.js home apps

or you can shortcut and build all the things:

$ _build/build.js all

The resulting files go into a directory, e.g. api, then Jekyll compiles any file with YAML front matter, or puts any file without YAML front matter verbatim in _site.

API docs

To build just a subset of the API docs, or build docs for a specific version, use the _build/jsdoc/jsdoc.js command. It takes arguments for which project and version docs you want to build.

# Locally checked out Montage
$ _build/jsdoc/jsdoc.js montage npm-link $PWD/api
# Version of Montage
$ _build/jsdoc/jsdoc.js montage v0.13.9 $PWD/api
# Version of Digit
$ _build/jsdoc/jsdoc.js digit v0.4.0 $PWD/api