This repository holds the documentation source code for the Nimbus Framework.
The documentation is maintained using Asciidoctor.
- Install Asciidoctor
- Install coderay (for syntax highlighting)
npm run buildnpm run build Arguments
| name | description |
|---|---|
| debug | run the script in debug mode. default: false |
| quiet | whether or not to execute the build without user interaction. default: false |
| update-latest | whether or not to use the generated documentation as the "latest" version as well. Options are 'y' or 'n'. default: n |
| version | the version of the documentation. default: package.json[version] + package.json[release-type] |
npm run publishnpm run publish Arguments
| name | description |
|---|---|
| version | the version of the documentation. default: package.json[version] + package.json[release-type] |
To publish the contents of dist/latest to the latest directory in the Github Pages site, run the following:
npm run publish-latestThe published documentation is hosted on GitHub (gh-pages) and can be found here: https://openanthem.github.io/nimbus-docs
Other helpful resources may be found within the Nimbus Atlassian Wiki.