aboutsummaryrefslogtreecommitdiff
path: root/docs/getting-started
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2015-01-19 14:48:12 -0800
committerMark Otto <[email protected]>2015-01-19 14:48:12 -0800
commit325748ff6860fbafaac21e3bfbaabfdb05fa71a8 (patch)
tree0fc4e65149990e9d59029c09e24a0242ffa8a2d0 /docs/getting-started
parent0964504fdafdde0ac71ab1a6f65eea1686cef9f8 (diff)
parent4fd01b7ac130dd815e7490950ed807487b684f4a (diff)
downloadbootstrap-325748ff6860fbafaac21e3bfbaabfdb05fa71a8.tar.xz
bootstrap-325748ff6860fbafaac21e3bfbaabfdb05fa71a8.zip
Merge branch 'master' into v4
Conflicts: _config.yml dist/css/bootstrap-theme.css dist/css/bootstrap-theme.css.map dist/css/bootstrap-theme.min.css dist/css/bootstrap.css dist/css/bootstrap.css.map dist/css/bootstrap.min.css dist/js/bootstrap.min.js docs/_includes/components/thumbnails.html docs/_includes/css/forms.html docs/_includes/css/grid.html docs/_includes/customizer-variables.html docs/_includes/footer.html docs/_includes/getting-started/download.html docs/_includes/getting-started/template.html docs/_includes/js/overview.html docs/_includes/js/popovers.html docs/_includes/js/tooltips.html docs/assets/css/docs.min.css docs/assets/js/customize.min.js docs/assets/js/raw-files.min.js docs/assets/js/src/customizer.js docs/dist/css/bootstrap-theme.css docs/dist/css/bootstrap-theme.css.map docs/dist/css/bootstrap-theme.min.css docs/dist/css/bootstrap.css docs/dist/css/bootstrap.css.map docs/dist/css/bootstrap.min.css docs/dist/js/bootstrap.js docs/dist/js/bootstrap.min.js docs/examples/navbar-fixed-top/index.html docs/examples/navbar-static-top/index.html docs/examples/non-responsive/index.html docs/examples/theme/index.html grunt/configBridge.json less/alerts.less less/badges.less less/jumbotron.less less/panels.less less/tables.less less/theme.less less/variables.less package.json scss/_button-group.scss scss/_buttons.scss scss/_forms.scss
Diffstat (limited to 'docs/getting-started')
-rw-r--r--docs/getting-started/download.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/getting-started/download.md b/docs/getting-started/download.md
index 1fd4ae658..b22354553 100644
--- a/docs/getting-started/download.md
+++ b/docs/getting-started/download.md
@@ -45,6 +45,13 @@ Bootstrap is available as [an npm package](https://www.npmjs.org/package/bootstr
{% highlight bash %}$ npm install bootstrap{% endhighlight %}
-### Autoprefixer required for Less/Sass
+`require('bootstrap')` will load all of Bootstrap's jQuery plugins onto the jQuery object. The `bootstrap` module itself does not export anything. You can manually load Bootstrap's jQuery plugins individually by loading the `/js/*.js` files under the package's top-level directory.
-Bootstrap uses [Autoprefixer](https://github.com/postcss/autoprefixer) to deal with [CSS vendor prefixes](http://webdesign.about.com/od/css/a/css-vendor-prefixes.htm). 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.
+Bootstrap's `package.json` contains some additional metadata under the following keys:
+
+- `less` - path to Bootstrap's main [Less](http://lesscss.org) source file
+- `style` - path to Bootstrap's non-minified CSS that's been precompiled using the default settings (no customization)
+
+### Autoprefixer required
+
+Bootstrap uses [Autoprefixer](https://github.com/postcss/autoprefixer) to deal with [CSS vendor prefixes](http://webdesign.about.com/od/css/a/css-vendor-prefixes.htm). If you're compiling Bootstrap from its source Sass 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 as Autoprefixer is already integrated into our Gruntfile.