To generate the various files required by the website, run the following
command (using the actual version number in place of
$ VERSION=X.Y.Z make
Start local server
This repo contains all the prebuilt files used on the site.
It also contains a static file server (available after
npm run server
Once this is running, visit localhost:8080 to view the docs.
In the event that
:8080 is in use, you can change the port like so:
npm run server -- -p 8081
For more details on configuring the server, see http-server docs.
What to do on a new release
Update package.json to latest version of
npm run make_release
Node 6 or above is required in order to build jsdoc.
If you are using nvm, simply run:
nvm install && nvm use
To rebuild the docs page:
npm run jsdoc
To rebuild the main style.css:
npm run less