rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-30 12:24:19 +01:00
Code Issues Actions Packages Releases Activity
cf5284f235
Bootstrap/docs/getting-started/build-tools.md
Mark Otto c064eef67b Massive cleanup 
- Simpler main nav on all pages
- Back to purple masthead on homepage instead of dark graphite
- Active link styles on the main nav
- Cleaned up sidebar nav
- New docs layout name
- Homepage copy edits
- Updated bright purple docs color
2015-08-14 22:45:55 -07:00

3.7 KiB
Raw Blame History

layout title group
docs Build tools getting-started

Bootstrap uses Grunt for its CSS and JavaScript build system and Jekyll for the written documentation. Our Gruntfile includes convenient methods for working with the framework, including compiling code, running tests, and more.

Tooling setup

To use our Gruntfile and run our documentation locally, you'll need a copy of Bootstrap's source files, Node, and Grunt. Follow these steps and you should be ready to rock:

  1. Download and install Node, which we use to manage our dependencies.
  2. Install the Grunt command line tools, grunt-cli, with npm install -g grunt-cli.
  3. Navigate to the root /bootstrap directory and run npm install to install our local dependencies listed in package.json.
  4. Install Ruby, install Bundler with gem install bundler, and finally run bundle. This will install all Ruby dependencies, such as Jekyll and Sass linter.

When completed, you'll be able to run the various Grunt commands provided from the command line.

Using Grunt

Our Gruntfile includes the following commands and tasks:

Task Description
grunt Run grunt to run tests locally and compile the CSS and JavaScript into /dist. Uses Sass and UglifyJS.
grunt dist grunt dist creates the /dist directory with compiled files. Uses Sass and UglifyJS.
grunt test Runs JSHint and QUnit tests headlessly in PhantomJS (used for CI).
grunt docs Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via jekyll serve.
grunt watch This is a convenience method for watching just Sass files and automatically building them whenever you save.

Switching Sass compilers

Bootstrap will be compiled with libsass by default, but you can opt into traditional Ruby Sass by setting the TWBS_SASS environment variable. Two options are supported:

For example, run TWBS_SASS=sass grunt to test and build Bootstrap with Ruby Sass.

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 above to install Jekyll (the site builder) and Rouge (our syntax highlighter).
  1. From the root /bootstrap directory, run jekyll serve in the command line.
  2. 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 or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.