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:
- 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 in .
When completed, you’ll be able to run the various commands provided from the command line.
Using npm scripts
Our includes numerous tasks for developing the project. Run npm run
to see all the npm scripts in your terminal. Primary tasks include:
Bootstrap uses Dart Sass for compiling our Sass source files into CSS files (included in our build process), and we recommend you do the same if you’re compiling Sass using your own asset pipeline. We previously used Node Sass for Bootstrap v4, but LibSass and packages built on top of it, including Node Sass, are now .
Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don’t lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.
Autoprefixer
Bootstrap uses (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.
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 and value directives.
Local documentation
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:
- Run through the above to install all dependencies.
- From the root
/bootstrap
directory, runnpm run docs-serve
in the command line.
Learn more about using Hugo by reading its documentation.