From 4b1c2c3d92e1f1bdd330548c5a5c9a32f1cc7da8 Mon Sep 17 00:00:00 2001 From: Haralan Dobrev Date: Mon, 7 Sep 2015 15:10:42 +0300 Subject: Recommend using bundle for running docs locally Closes https://github.com/twbs/bootstrap/issues/17493 --- docs/getting-started/build-tools.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index adda6cbb1..9b84a125d 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -13,7 +13,8 @@ To use our Gruntfile and run our documentation locally, you'll need a copy of Bo 1. [Download and install Node](https://nodejs.org/download), 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](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`. This will install all Ruby dependencies, such as Jekyll and Sass linter. +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 Grunt commands provided from the command line. @@ -50,9 +51,8 @@ For example, run `TWBS_SASS=sass grunt` to test and build Bootstrap with Ruby Sa 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 Rouge (our syntax highlighter). - - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. -2. From the root `/bootstrap` directory, run `jekyll serve` in the command line. +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 `bundle exec jekyll serve` in the command line. 3. Open in your browser, and voilà. Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). -- cgit v1.2.3 From e10104cc35672db77747c8b1622136555501bdc7 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 14 Nov 2015 19:21:25 -0800 Subject: Add note to build tools docs section about autoprefixer --- docs/getting-started/build-tools.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index 9b84a125d..af0d7168e 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -47,6 +47,12 @@ For example, run `TWBS_SASS=sass grunt` to test and build Bootstrap with Ruby Sa [libsass]: https://github.com/sass/libsass [grunt-sass]: https://github.com/sindresorhus/grunt-sass +## Autoprefixer + +Bootstrap uses [Autoprefixer][autoprefixer] (included in our Gruntfile and 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. + +[autoprefixer]: https://github.com/postcss/autoprefixer + ## 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: -- cgit v1.2.3 From 9e01f45656e13dc31c9e29bf01682d3004039f7c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 14 Nov 2015 19:28:14 -0800 Subject: consolidate links at the bottom of the file --- docs/getting-started/build-tools.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index af0d7168e..b54a568ef 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -42,16 +42,10 @@ Bootstrap will be compiled with [libsass][libsass] by default, but you can opt i 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 - ## Autoprefixer Bootstrap uses [Autoprefixer][autoprefixer] (included in our Gruntfile and 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. -[autoprefixer]: https://github.com/postcss/autoprefixer ## Local documentation @@ -66,3 +60,9 @@ Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com ## Troubleshooting Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`. + +[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 +[autoprefixer]: https://github.com/postcss/autoprefixer -- cgit v1.2.3 From bbdd39300310bf236a17bc196972c43a3374f97f Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 14 Nov 2015 19:28:45 -0800 Subject: contextual shoutout --- docs/getting-started/build-tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index b54a568ef..b029b3dd5 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -28,7 +28,7 @@ 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](http://sass-lang.com/) and [UglifyJS](http://lisperator.net/uglifyjs/).** | -| `grunt dist` | `grunt dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/) and [UglifyJS](http://lisperator.net/uglifyjs/).** | +| `grunt dist` | `grunt dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer] and [UglifyJS](http://lisperator.net/uglifyjs/).** | | `grunt test` | Runs [scss-lint](https://github.com/brigade/scss-lint), [ESLint](http://eslint.org/) and [QUnit](http://qunitjs.com/) tests headlessly in [PhantomJS](http://phantomjs.org/) (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. | -- cgit v1.2.3 From 37c2681e9f24d9fcadedfe8fa5685972718956dc Mon Sep 17 00:00:00 2001 From: Chris Rebert Date: Sat, 14 Nov 2015 19:31:41 -0800 Subject: One more Autoprefixer shoutout [skip sauce] --- docs/getting-started/build-tools.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index b029b3dd5..0dabd30f9 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -27,8 +27,8 @@ 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](http://sass-lang.com/) and [UglifyJS](http://lisperator.net/uglifyjs/).** | -| `grunt dist` | `grunt dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer] and [UglifyJS](http://lisperator.net/uglifyjs/).** | +| `grunt` | Run `grunt` 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/).** | +| `grunt dist` | `grunt dist` creates the `/dist` directory with compiled files. **Uses [Sass](http://sass-lang.com/), [Autoprefixer][autoprefixer], and [UglifyJS](http://lisperator.net/uglifyjs/).** | | `grunt test` | Runs [scss-lint](https://github.com/brigade/scss-lint), [ESLint](http://eslint.org/) and [QUnit](http://qunitjs.com/) tests headlessly in [PhantomJS](http://phantomjs.org/) (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. | -- cgit v1.2.3