diff options
| author | Chris Rebert <[email protected]> | 2015-01-14 18:43:04 -0800 |
|---|---|---|
| committer | Chris Rebert <[email protected]> | 2015-01-14 18:43:08 -0800 |
| commit | ccc3eb5cc608b4642196581ab1678ecfdae812a4 (patch) | |
| tree | 102d26c3f604ced1acbe9da0dbcdc8e8d5393ef5 | |
| parent | fb6622a7d44c99323bea5bd69cb0604470bbe21a (diff) | |
| download | bootstrap-ccc3eb5cc608b4642196581ab1678ecfdae812a4.tar.xz bootstrap-ccc3eb5cc608b4642196581ab1678ecfdae812a4.zip | |
document usage of npm package; fixes #15127
[skip sauce]
| -rw-r--r-- | docs/_includes/getting-started/download.html | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/_includes/getting-started/download.html b/docs/_includes/getting-started/download.html index fd81a405b..7059dc6d1 100644 --- a/docs/_includes/getting-started/download.html +++ b/docs/_includes/getting-started/download.html @@ -44,6 +44,16 @@ <p>You can also install and manage Bootstrap's Less, CSS, JavaScript, and fonts using <a href="http://bower.io">Bower</a>:</p> {% highlight bash %}$ bower install bootstrap{% endhighlight %} + <h3 id="download-npm">Install with npm</h3> + <p>You can also install Bootstrap using <a href="https://www.npmjs.com">npm</a>:</p> + {% highlight bash %}$ npm install bootstrap{% endhighlight %} + <p><code>require('bootstrap')</code> will load all of Bootstrap's jQuery plugins onto the jQuery object. The <code>bootstrap</code> module itself does not export anything. You can manually load Bootstrap's jQuery plugins individually by loading the <code>/js/*.js</code> files under the package's top-level directory.</p> + <p>Bootstrap's <code>package.json</code> contains some additional metadata under the following keys:</p> + <ul> + <li><code>less</code> - path to Bootstrap's main <a href="lesscss.org">Less</a> source file</li> + <li><code>style</code> - path to Bootstrap's non-minified CSS that's been precompiled using the default settings (no customization)</li> + </ul> + <h3 id="download-autoprefixer">Autoprefixer required for Less/Sass</h3> <p>Bootstrap uses <a href="https://github.com/postcss/autoprefixer">Autoprefixer</a> to deal with <a href="http://webdesign.about.com/od/css/a/css-vendor-prefixes.htm">CSS vendor prefixes</a>. If you're compiling Bootstrap from its Less/Sass source and not using our Gruntfile, you'll need to integrate Autoprefixer into your build process yourself. If you're using precompiled Bootstrap or using our Gruntfile, you don't need to worry about this because Autoprefixer is already integrated into our Gruntfile.</p> </div> |