This project uses npm scripts for its build system. Our package.json
includes convenient methods for working with the framework, including compiling code, running tests, and more.
To use our build system and run our documentation locally, you'll need a copy of project's source files and Node. Follow these steps and you should be ready to rock:
- Download and install Node.js, which we use to manage our dependencies.
- Navigate to the root directory and run
npm install
to install our local dependencies listed inpackage.json
. - Install Ruby, install Bundler with
gem install bundler
, and finally runbundle install
. This will install all Ruby dependencies, such as Jekyll and plugins.
- Windows users: Read this guide to get Jekyll up and running without problems.
When completed, you'll be able to run the various commands provided from the command line.
npm run build
: build project to pure HTML/CSS/JS, all files will be placed in_site
folder.npm run clean
: cleanup generated stuffs, such as: Jekyll cache folder,_site
folder;npm run start
: start development with file watchers and local Jekyll's server (http://localhost:4000/);
This theme is using selectize.js to support tags input.
<input data-toggle="tags" />