e00de46540
The link to package.json in the v4 docs was linking to package.json in the v3 source. Fixed to point to the correct v4 location. A change like this will need to be made for all branches on version 4 if you want the docs to be linked correctly (github may be smart enough to follow the link to the current branch if you are on github but it was wrong from the main site).
3.6 KiB
| layout | title | description | group |
|---|---|---|---|
| docs | Build tools | Details on how to use Bootstrap's included build tools to compile source code, run tests, and more. | getting-started |
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.
Contents
- Will be replaced with the ToC, excluding the "Contents" header {:toc}
Tooling setup
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, which we use to manage our dependencies.
- Navigate to the root
/bootstrapdirectory and runnpm installto install our local dependencies listed in package.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 unofficial 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 test |
Run npm test to run tests locally and compile the CSS and JavaScript into /dist. Uses Sass, Autoprefixer, and UglifyJS. |
npm run dist |
npm run dist creates the /dist directory with compiled files. Uses Sass, Autoprefixer, and UglifyJS. |
npm run docs |
Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via npm run docs-serve. |
Autoprefixer
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 /build/postcss.js for details.
Local documentation
Running our documentation locally requires the use of Jekyll, a decently flexible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here's how to get it started:
- Run through the tooling setup above to install Jekyll (the site builder) and other Ruby dependencies with
bundle install. - From the root
/bootstrapdirectory, runnpm run docs-servein the command line. - Open http://localhost:9001 in your browser, and voilà.
Learn more about using Jekyll by reading its documentation.
Troubleshooting
Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun npm install.