Skip to content

Commit 5949150

Browse files
authored
Merge pull request #9 from edx/thallada/readme-webpack
Add additional docs to README
2 parents ce01520 + f6f64f3 commit 5949150

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Getting Started
1212

1313
The edx-bootstrap library should be installed via npm:
1414

15-
npm install edx-bootstrap
15+
npm install --save edx-bootstrap
1616

1717
Once installed, you can generate the `sample pages`_:
1818

@@ -35,6 +35,18 @@ See the `sample Open edX SASS file`_ for a simple example.
3535

3636
.. _sample Open edX SASS file: https://github.com/edx/edx-bootstrap/blob/master/samples/open-edx/sass/sample.scss
3737

38+
Using The EdX Bootstrap Theme With Webpack
39+
------------------------------------------
40+
41+
The edX Bootstrap Sass expects the Bootstrap source to exist at the project root.
42+
Add an includePaths option to your sass-loader config so that Webpack knows
43+
to look for Bootstrap in your node_modules folder.
44+
45+
See a `sample Webpack config`_ in edx-paragon, which uses edX Bootstrap and Webpack.
46+
47+
.. _sample Webpack config: https://github.com/edx/paragon/blob/master/webpack.config.js#L56
48+
49+
3850
License
3951
-------
4052

0 commit comments

Comments
 (0)