Project used to generate contents of the Developer Documentation.
Run npm i
with Node v4.
We use node-config
, please refer to config/default.yaml
for more info.
In order to use local repositories (such as backend for fast raml doc preview).
You need to specify the repos
section in the config such as this:
repos:
backend: ../backend
Run gulp
for a full build.
Run gulp recompile
for a build without JavaDoc and RAMLDoc.
Run gulp watch
for development.
Run npm test
before pull requesting any changes.