diff options
author | Max Kostikov <max@kostikov.co> | 2018-09-28 15:46:14 +0200 |
---|---|---|
committer | Max Kostikov <max@kostikov.co> | 2018-09-28 15:46:14 +0200 |
commit | 4a904fa3a8af1c101ede76657249fb7eb47faf60 (patch) | |
tree | 544509813fb68579ef2b556ce879a971d183269a /vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md | |
parent | f5f6ec3d71acb3e0488386819d5060e59331ec23 (diff) | |
parent | c13d7e29ef9676b0f0e4ae23aa52e203f4ad8895 (diff) | |
download | volse-hubzilla-4a904fa3a8af1c101ede76657249fb7eb47faf60.tar.gz volse-hubzilla-4a904fa3a8af1c101ede76657249fb7eb47faf60.tar.bz2 volse-hubzilla-4a904fa3a8af1c101ede76657249fb7eb47faf60.zip |
Merge branch 'patch-29' into 'dev'
Patch 29
See merge request Kostikov/core!3
Diffstat (limited to 'vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md')
-rw-r--r-- | vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md b/vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md new file mode 100644 index 000000000..59211b075 --- /dev/null +++ b/vendor/twbs/bootstrap/site/docs/4.1/getting-started/webpack.md @@ -0,0 +1,94 @@ +--- +layout: docs +title: Webpack +description: Learn how to include Bootstrap in your project using Webpack 3. +group: getting-started +toc: true +--- + +## Installing Bootstrap + +[Install bootstrap]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/download/#npm) as a Node.js module using npm. + +## Importing JavaScript + +Import [Bootstrap's JavaScript]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/javascript/) by adding this line to your app's entry point (usually `index.js` or `app.js`): + +{% highlight js %} +import 'bootstrap'; +{% endhighlight %} + +Alternatively, you may **import plugins individually** as needed: + +{% highlight js %} +import 'bootstrap/js/dist/util'; +import 'bootstrap/js/dist/alert'; +... +{% endhighlight %} + +Bootstrap is dependent on [jQuery](https://jquery.com/) and [Popper](https://popper.js.org/), +these are defined as `peerDependencies`, this means that you will have to make sure to add both of them +to your `package.json` using `npm install --save jquery popper.js`. + +## Importing Styles + +### Importing Precompiled Sass + +To enjoy the full potential of Bootstrap and customize it to your needs, use the source files as a part of your project's bundling process. + +First, create your own `_custom.scss` and use it to override the [built-in custom variables]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/options/). Then, use your main Sass file to import your custom variables, followed by Bootstrap: + +{% highlight scss %} +@import "custom"; +@import "~bootstrap/scss/bootstrap"; +{% endhighlight %} + +For Bootstrap to compile, make sure you install and use the required loaders: [sass-loader](https://github.com/webpack-contrib/sass-loader), [postcss-loader](https://github.com/postcss/postcss-loader) with [Autoprefixer](https://github.com/postcss/autoprefixer#webpack). With minimal setup, your webpack config should include this rule or similar: + +{% highlight js %} + ... + { + test: /\.(scss)$/, + use: [{ + loader: 'style-loader', // inject CSS to page + }, { + loader: 'css-loader', // translates CSS into CommonJS modules + }, { + loader: 'postcss-loader', // Run post css actions + options: { + plugins: function () { // post css plugins, can be exported to postcss.config.js + return [ + require('precss'), + require('autoprefixer') + ]; + } + } + }, { + loader: 'sass-loader' // compiles Sass to CSS + }] + }, + ... +{% endhighlight %} + +### Importing Compiled CSS + +Alternatively, you may use Bootstrap's ready-to-use CSS by simply adding this line to your project's entry point: + +{% highlight js %} +import 'bootstrap/dist/css/bootstrap.min.css'; +{% endhighlight %} + +In this case you may use your existing rule for `css` without any special modifications to webpack config, except you don't need `sass-loader` just [style-loader](https://github.com/webpack-contrib/style-loader) and [css-loader](https://github.com/webpack-contrib/css-loader). + +{% highlight js %} + ... + module: { + rules: [ + { + test: /\.css$/, + use: ['style-loader', 'css-loader'] + } + ] + } + ... +{% endhighlight %} |