From 5d8880fdfae7de50d867eb9695b704f50ab77775 Mon Sep 17 00:00:00 2001 From: Chris Rebert Date: Wed, 7 May 2014 19:38:27 -0700 Subject: move Grunt info from README into HTML docs Fixes #13470 --- docs/_includes/getting-started/grunt.html | 32 +++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/_includes/getting-started/grunt.html (limited to 'docs/_includes/getting-started') diff --git a/docs/_includes/getting-started/grunt.html b/docs/_includes/getting-started/grunt.html new file mode 100644 index 000000000..93fa44a70 --- /dev/null +++ b/docs/_includes/getting-started/grunt.html @@ -0,0 +1,32 @@ +
+

Compiling CSS and JavaScript

+ +

Bootstrap uses Grunt for its build system, with convenient methods for working with the framework. It's how we compile our code, run tests, and more.

+ +

Installing Grunt

+

To install Grunt, you must first download and install node.js (which includes npm). npm stands for node packaged modules and is a way to manage development dependencies through node.js.

+ + Then, from the command line: +
    +
  1. Install grunt-cli globally with npm install -g grunt-cli.
    2. +
  2. Navigate to the root /bootstrap/ directory, then run npm install. npm will look at the package.json file and automatically install the necessary local dependencies listed there.
    3. +
+ +

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

+ +

Available Grunt commands

+

grunt dist (Just compile CSS and JavaScript)

+

Regenerates the /dist/ directory with compiled and minified CSS and JavaScript files. As a Bootstrap user, this is normally the command you want.

+ +

grunt watch (Watch)

+

Watches the Less source files and automatically recompiles them to CSS whenever you save a change.

+ +

grunt test (Run tests)

+

Runs JSHint and runs the QUnit tests headlessly in PhantomJS.

+ +

grunt (Build absolutely everything and run tests)

+

Compiles and minifies CSS and JavaScript, builds the documentation website, runs the HTML5 validator against the docs, regenerates the Customizer assets, and more. Usually only necessary if you're hacking on Bootstrap itself.

+ +

Troubleshooting

+

Should you encounter problems with installing dependencies or running Grunt commands, first delete the /node_modules/ directory generated by npm. Then, rerun npm install.

+
-- cgit v1.2.3 From ed98b3dfc012166d01c72fc80caa0113e37b4d45 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Sat, 10 May 2014 09:22:43 +0300 Subject: Update html5shiv to 3.7.2. --- docs/_includes/getting-started/template.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_includes/getting-started') diff --git a/docs/_includes/getting-started/template.html b/docs/_includes/getting-started/template.html index de0515342..c3b1560aa 100644 --- a/docs/_includes/getting-started/template.html +++ b/docs/_includes/getting-started/template.html @@ -19,7 +19,7 @@ -- cgit v1.2.3 From be00b82bb95c6defc02a66f2d599fec56fbcaa85 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 12 May 2014 19:55:58 -0700 Subject: nuke the rtl docs --- docs/_includes/getting-started/rtl.html | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 docs/_includes/getting-started/rtl.html (limited to 'docs/_includes/getting-started') diff --git a/docs/_includes/getting-started/rtl.html b/docs/_includes/getting-started/rtl.html deleted file mode 100644 index 55568ccd6..000000000 --- a/docs/_includes/getting-started/rtl.html +++ /dev/null @@ -1,25 +0,0 @@ -
-

RTL

-

As of Bootstrap 3.2, a right-to-left version of Bootstrap ships as part of the repository. It's powered by Twitter's CSS Flip project and is generated via our Gruntfile.

- -

How to use

-

Bootstrap is by default a left-to-right project. For right-to-left projects, you'll need to set your language and replace the default Bootstrap CSS with an RTL version. First, set your language and text direction:

-{% highlight html %} - - -{% endhighlight %} -

Then, include the right-to-left CSS file instead of the default Bootstrap CSS:

-{% highlight html %} - - -{% endhighlight %} -

Alternatively, you may use the minified RTL file, bootstrap-rtl.min.css.

- -
-

Do not use in combination with bootstrap.css

-

bootstrap-rtl.css must not be used together with bootstrap.css. Use either one or the other, but not both. bootstrap-rtl.css includes all of Bootstrap's styles, including those not affected by writing direction.

-
- -

CSS Flip

-

CSS Flip is a project for converting left-to-right CSS files into right-to-left CSS files. We use it in our Gruntfile to automate the generation of Bootstrap's RTL CSS files.

-
-- cgit v1.2.3 From 7a765d1f8b45dd10d40e6c9ac5ad144ff95a9b0d Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Tue, 13 May 2014 08:33:23 +0300 Subject: Update jQuery to v1.11.1. --- docs/_includes/getting-started/template.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_includes/getting-started') diff --git a/docs/_includes/getting-started/template.html b/docs/_includes/getting-started/template.html index c3b1560aa..3952621a6 100644 --- a/docs/_includes/getting-started/template.html +++ b/docs/_includes/getting-started/template.html @@ -27,7 +27,7 @@

Hello, world!

- + -- cgit v1.2.3 From d0fca8aaad4999d3389ebdada36102c89063e0f2 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Tue, 13 May 2014 09:26:24 +0300 Subject: Remove RTL leftovers. --- docs/_includes/getting-started/download.html | 3 --- docs/_includes/getting-started/whats-included.html | 2 -- 2 files changed, 5 deletions(-) (limited to 'docs/_includes/getting-started') diff --git a/docs/_includes/getting-started/download.html b/docs/_includes/getting-started/download.html index b457d038e..c89c8b9e4 100644 --- a/docs/_includes/getting-started/download.html +++ b/docs/_includes/getting-started/download.html @@ -33,9 +33,6 @@ - - - diff --git a/docs/_includes/getting-started/whats-included.html b/docs/_includes/getting-started/whats-included.html index 278ebac60..8500e573c 100644 --- a/docs/_includes/getting-started/whats-included.html +++ b/docs/_includes/getting-started/whats-included.html @@ -17,8 +17,6 @@ bootstrap/ ├── css/ │ ├── bootstrap.css │ ├── bootstrap.min.css -│ ├── bootstrap-rtl.css -│ ├── bootstrap-rtl.min.css │ ├── bootstrap-theme.css │ └── bootstrap-theme.min.css ├── js/ -- cgit v1.2.3 From 239d5e0e3905c4463651fc94a9ed175bdc2e827c Mon Sep 17 00:00:00 2001 From: Chris Rebert Date: Tue, 13 May 2014 04:19:51 -0700 Subject: add link to StackOverflow question regarding Android