mirror of
https://github.com/mdbootstrap/mdb-ui-kit.git
synced 2024-11-26 11:34:05 +03:00
56 lines
3.6 KiB
Markdown
56 lines
3.6 KiB
Markdown
|
---
|
||
|
|
layout: docs
|
||
|
|
title: Build tools
|
||
|
|
description: Learn how to use Bootstrap's included npm scripts to build our documentation, compile source code, run tests, and more.
|
||
|
|
group: getting-started
|
||
|
|
toc: true
|
||
|
|
---
|
||
|
|
|
||
|
|
## Tooling setup
|
||
|
|
|
||
|
|
Bootstrap uses [NPM scripts](https://docs.npmjs.com/misc/scripts) for its build system. Our [package.json](https://github.com/twbs/bootstrap/blob/v4-dev/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](https://nodejs.org/download/), 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](https://github.com/twbs/bootstrap/blob/master/package.json).
|
||
|
|
4. [Install Ruby][install-ruby], install [Bundler][gembundler] with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as Jekyll and plugins.
|
||
|
|
- **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
|
||
|
|
|
||
|
|
When completed, you'll be able to run the various commands provided from the command line.
|
||
|
|
|
||
|
|
[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/
|
||
|
|
[gembundler]: https://bundler.io/
|
||
|
|
|
||
|
|
## Using NPM scripts
|
||
|
|
|
||
|
|
Our [package.json](https://github.com/twbs/bootstrap/blob/master/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](http://sass-lang.com/), [Autoprefixer][autoprefixer], and [UglifyJS](http://lisperator.net/uglifyjs/).** |
|
||
|
|
| `npm run dist` | `npm run dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer], and [UglifyJS](http://lisperator.net/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][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.config.js`](https://github.com/twbs/bootstrap/blob/v4-dev/build/postcss.config.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:
|
||
|
|
|
||
|
|
1. Run through the [tooling setup](#tooling-setup) above to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
|
||
|
|
2. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line.
|
||
|
|
3. Open <http://localhost:9001> in your browser, and voilà.
|
||
|
|
|
||
|
|
Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/).
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.
|
||
|
|
|
||
|
|
[autoprefixer]: https://github.com/postcss/autoprefixer
|