Tooling

Warning
This documentation is out-of-date and needs reviewing and updating.

npm scripts

command	action
npm start	Runs the default gulp task
npm test	Runs CSS linting
npm build-gh-pages	Build documentation with a base url that is suitable for publishing on github pages
npm build-gh-release	Runs gulp zip for publishing to github releases

Gulp tasks

We use gulp for automating common tasks.

To run a gulp task, run ./node_modules/.bin/gulp <task_name> on the command line.

task	action
default	Serve the documentation on port 3000. Recompile when there are changes
clean	Remove all compiled files
style	Compiles CSS
build	Compiles CSS and JS
bundle	Creates distributable CSS and JS files in dist/
zip	Creates a distributable zip file in dist/
watch	Recompile documentation and distributables when there are changes
docs:build	Recompile documentation
docs:serve	Serve documentation on port 3000

---

Next: Linting