From ec697b2076182836c58e2b3caa385d7e6b164d15 Mon Sep 17 00:00:00 2001 From: Pierre-Denis Vanduynslager Date: Sat, 14 Jan 2017 20:11:57 -0500 Subject: Update broken links. (#21696) --- 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 0d441d216..04b2873b6 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -43,7 +43,7 @@ Our Gruntfile includes the following commands and tasks: 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. -We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [`/grunt/postcss.js`](https://github.com/twbs/bootstrap/blob/master/grunt/postcss.js) for details. +We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [`/grunt/postcss.js`](https://github.com/twbs/bootstrap/blob/v4-dev/grunt/postcss.js) for details. ## Local documentation -- cgit v1.2.3 From 2906b612d5bc3d7e33950044c9b89a91b117df03 Mon Sep 17 00:00:00 2001 From: Bardi Harborow Date: Thu, 20 Apr 2017 20:33:51 +1000 Subject: More minor build tweaks and docs updates. --- docs/getting-started/build-tools.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 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 04b2873b6..8c5b635b3 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -5,7 +5,7 @@ description: Details on how to use Bootstrap's included build tools to compile s group: getting-started --- -Bootstrap uses [Grunt](http://gruntjs.com) 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. +Bootstrap uses [NPM scripts](https://docs.npmjs.com/misc/scripts) for its build system. Our [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) includes convenient methods for working with the framework, including compiling code, running tests, and more. ## Contents @@ -14,49 +14,46 @@ Bootstrap uses [Grunt](http://gruntjs.com) for its CSS and JavaScript build syst ## 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: +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. 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). +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 Grunt commands provided from the command line. +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 Grunt +## Using NPM scripts -Our Gruntfile includes the following commands and tasks: +Our [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) 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/), [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](https://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. | +| `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 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. +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 [`/grunt/postcss.js`](https://github.com/twbs/bootstrap/blob/v4-dev/grunt/postcss.js) for details. +We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [`/build/postcss.js`](https://github.com/twbs/bootstrap/blob/v4-dev/build/postcss.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 `bundle exec jekyll serve` in the command line. +2. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line. 3. Open 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 or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`. +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 -- cgit v1.2.3 From e00de46540818fa11feb6d1f0e8b0089ba56f082 Mon Sep 17 00:00:00 2001 From: Peter Gerdes Date: Mon, 1 May 2017 23:23:38 +0300 Subject: Link to package.json Fixed The link to package.json in the v4 docs was linking to package.json in the v3 source. Fixed to point to the correct v4 location. A change like this will need to be made for all branches on version 4 if you want the docs to be linked correctly (github may be smart enough to follow the link to the current branch if you are on github but it was wrong from the main site). --- 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 8c5b635b3..3482bb617 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -5,7 +5,7 @@ description: Details on how to use Bootstrap's included build tools to compile s group: getting-started --- -Bootstrap uses [NPM scripts](https://docs.npmjs.com/misc/scripts) for its build system. Our [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) includes convenient methods for working with the framework, including compiling code, running tests, and more. +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. ## Contents -- cgit v1.2.3 From 5fa262adeceacb0bfc0a1d17d1ea9d061e3971f8 Mon Sep 17 00:00:00 2001 From: Ayachii Date: Thu, 25 May 2017 00:50:22 -0400 Subject: Fix 22643 - Readme links to vanished file (#22647) * Fixed dead link to browser list The link to the list of browsers supported through Autoprefixer was dead, now updated to a working link. * Updated label to display new file path Changed the labeling on the updated link to show read as the new updated file path. --- 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 3482bb617..6c1353052 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -40,7 +40,7 @@ Our [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) i 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.js`](https://github.com/twbs/bootstrap/blob/v4-dev/build/postcss.js) for details. +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 -- cgit v1.2.3 From 1f43d9c066f1ffd008f2cb4b00907165d905f3fc Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 27 May 2017 22:03:48 -0700 Subject: revamp getting started docs to use new toc --- docs/getting-started/build-tools.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 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 6c1353052..dd3cac0be 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -1,19 +1,15 @@ --- layout: docs title: Build tools -description: Details on how to use Bootstrap's included build tools to compile source code, run tests, and more. +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 --- -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. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## 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. -- cgit v1.2.3 From 3e76d6565603fafa2c85ad81d7b6345c4e279c72 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 22:50:57 -0700 Subject: Rearrange all the docs to allow for a docs/major.minor/ setup --- docs/getting-started/build-tools.md | 55 ------------------------------------- 1 file changed, 55 deletions(-) delete mode 100644 docs/getting-started/build-tools.md (limited to 'docs/getting-started/build-tools.md') diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md deleted file mode 100644 index dd3cac0be..000000000 --- a/docs/getting-started/build-tools.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 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 -- cgit v1.2.3