0e920ce3f4
With the current docs directory setup, I'm making too many mistakes and have to manually address path changes and directory moves on deploy. This makes for a frustrating experience developing locally and shipping releases. With this PR, we're basically back to the same setup from v3—duplicating the dist directory into our docs directory. Not the most ideal, but very straightforward for me as the release manager.
3.4 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Build tools | Learn how to use Bootstrap's included npm scripts to build our documentation, compile source code, run tests, and more. | getting-started | true |
Tooling setup
Bootstrap uses NPM scripts for its build system. Our [package.json]({{ site.repo }}/blob/v{{ site.current_version }}/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:
- Download and install Node.js, which we use to manage our dependencies.
- Navigate to the root
/bootstrapdirectory and runnpm installto install our local dependencies listed in [package.json]({{ site.repo }}/blob/v{{ site.current_version }}/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 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]({{ site.repo }}/blob/v{{ site.current_version }}/package.json) includes the following commands and tasks:
| Task | Description |
|---|---|
npm run dist |
npm run dist creates the /dist directory with compiled files. Uses Sass, Autoprefixer, and UglifyJS. |
npm test |
Same as npm run dist plus it runs tests locally |
npm run docs |
Builds and lints CSS and JavaScript for docs. You can then run the documentation locally via npm run docs-serve. |
Run npm run to see all the npm scripts.
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 [/package.json]({{ site.repo }}/blob/v{{ site.current_version }}/package.json) 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:9001in 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.