Build tools

Learn how to use Bootstrap’s included npm scripts to build our documentation, compile source code, run tests, and more.

Tooling setup

Bootstrap 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 Bootstrap’s source files and Node. Follow these steps and you should be ready to rock:

  1. Download and install Node.js, which we use to manage our dependencies.
  2. Navigate to the root /bootstrap directory and run npm install to install our local dependencies listed in package.json.
  3. Install Ruby, install Bundler with gem install bundler, and finally run bundle 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.

Using npm scripts

Our package.json includes the following commands and tasks:

Task Description
npm run dist npm run dist creates the /dist/ directory with compiled files.
npm run dev Same as npm run dist saving only as development dependencies
npm run watch Run scripts from package.json when files change. Builds and lints CSS and JavaScript for docs.