Learn how to use Bootstrap’s included npm scripts to build our documentation, compile source code, run 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:
/bootstrapdirectory and run
npm installto install our local dependencies listed in package.json.
When completed, you’ll be able to run the various commands provided from the command line.
Our package.json includes numerous tasks for developing the project. Run
npm run to see all the npm scripts in your terminal. Primary tasks include:
| || Creates the |
| || Runs tests locally after running |
| ||Builds and runs the documentation locally.|
Bootstrap uses Autoprefixer (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See .browserslistrc for details.
Bootstrap uses RTLCSS to process compiled CSS and convert them to RTL – basically replacing horizontal direction aware properties (eg.
padding-left) with their opposite. It allows us only write our CSS a single time and make minor tweaks using RTLCSS control and value directives.
Running our documentation locally requires the use of Hugo, which gets installed via the hugo-bin npm package. Hugo is a blazingly fast and quite extensible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here’s how to get it started:
npm run docs-servein the command line.
http://localhost:9001/in your browser, and voilà.
Learn more about using Hugo by reading its documentation.
Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun
© 2011–2020 Twitter, Inc.
© 2011–2020 The Bootstrap Authors
Code licensed under the MIT License.
Documentation licensed under the Creative Commons Attribution License v3.0.