diff options
| author | Mark Otto <[email protected]> | 2014-12-31 10:39:56 -0800 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2014-12-31 10:39:56 -0800 |
| commit | 1a932b7e02ccb091a6e99e74039f3ea949ce459e (patch) | |
| tree | 66b7012e97657bc5ad5542e59ded8f0064eb36e3 /docs/getting-started | |
| parent | a5e127fd168f33c087b645afb456c27c7da2bb6d (diff) | |
| parent | b9de4b739200537307112fdc59512a867a3f3774 (diff) | |
| download | bootstrap-1a932b7e02ccb091a6e99e74039f3ea949ce459e.tar.xz bootstrap-1a932b7e02ccb091a6e99e74039f3ea949ce459e.zip | |
Merge branch 'v4' of https://github.com/twbs/derpstrap into v4
Diffstat (limited to 'docs/getting-started')
| -rw-r--r-- | docs/getting-started/compiling.md | 18 | ||||
| -rw-r--r-- | docs/getting-started/quick-start.md | 2 | ||||
| -rw-r--r-- | docs/getting-started/third-party-support.md | 6 |
3 files changed, 22 insertions, 4 deletions
diff --git a/docs/getting-started/compiling.md b/docs/getting-started/compiling.md index 7a12becf7..38aa249d5 100644 --- a/docs/getting-started/compiling.md +++ b/docs/getting-started/compiling.md @@ -13,11 +13,15 @@ From the command line: 1. Install `grunt-cli` globally with `npm install -g grunt-cli`. 2. Navigate to the root `/bootstrap` directory, then run `npm install`. npm will look at [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) and automatically install the necessary local dependencies listed there. +3. [Install Ruby][install-ruby], install [Bundler][gembundler] 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. **Unfamiliar with npm? Don't have node installed?** That's a-okay. npm stands for [node packaged modules](http://npmjs.org/) and is a way to manage development dependencies through node.js. [Download and install node.js](http://nodejs.org/download/) before proceeding. +[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/ +[gembundler]: http://bundler.io/ + ### Available Grunt commands #### Build - `grunt` @@ -35,6 +39,20 @@ Builds and tests CSS, JavaScript, and other assets which are used when running t #### Watch - `grunt watch` This is a convenience method for watching just Sass files and automatically building them whenever you save. +### Use another Sass compiler +Bootstrap is compiled with [libsass][libsass] by default. +Use another compiler by setting the `TWBS_SASS` environment variable to: + +* `sass` to use [Ruby Sass][ruby-sass] via [grunt-contrib-sass][grunt-contrib-sass]. +* `libsass` (default) to use [libsass][libsass] via [grunt-sass][grunt-sass]. + +For example, run `TWBS_SASS=sass grunt` to test and build Bootstrap with Ruby Sass. + +[ruby-sass]: https://github.com/sass/sass +[grunt-contrib-sass]: https://github.com/gruntjs/grunt-contrib-sass +[libsass]: https://github.com/sass/libsass +[grunt-sass]: https://github.com/sindresorhus/grunt-sass + ### Troubleshooting dependencies Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`. diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index 6b1e68220..8e2f6814d 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -22,7 +22,7 @@ Then, add the Bootstrap JavaScript—and jQuery—near the end of your pages. It Be sure to have your pages set up with the latest design and development standards. That means: * Using an HTML5 doctype -* Forcing Internet Explorer to use it's latest rendering mode ([read more]()) +* Forcing Internet Explorer to use its latest rendering mode ([read more]()) * And, utilizing the viewport meta tag. Put it all together and your pages should look like this: diff --git a/docs/getting-started/third-party-support.md b/docs/getting-started/third-party-support.md index c469b644e..ea22cf589 100644 --- a/docs/getting-started/third-party-support.md +++ b/docs/getting-started/third-party-support.md @@ -16,7 +16,7 @@ Depending on the context, you may override as-needed (Option 1) or reset the box * * Reset individual elements or override regions to avoid conflicts due to * global box model settings of Bootstrap. Two options, individual overrides and - * region resets, are available as plain CSS and uncompiled Less formats. + * region resets, are available as plain CSS and uncompiled Sass formats. */ /* Option 1A: Override a single element's box model via CSS */ @@ -26,7 +26,7 @@ Depending on the context, you may override as-needed (Option 1) or reset the box box-sizing: content-box; } -/* Option 1B: Override a single element's box model by using a Bootstrap Less mixin */ +/* Option 1B: Override a single element's box model by using a Bootstrap Sass mixin */ .element { .box-sizing(content-box); } @@ -41,7 +41,7 @@ Depending on the context, you may override as-needed (Option 1) or reset the box box-sizing: content-box; } -/* Option 2B: Reset an entire region with a custom Less mixin */ +/* Option 2B: Reset an entire region with a custom Sass mixin */ .reset-box-sizing { &, *, |
