Update examples and README.md.

shakacode · Feb 5, 2016 · 2662d59 · 2662d59
1 parent 8bd18ff
commit 2662d59
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 0 deletions.
diff --git a/.bootstraprc-3-default b/.bootstraprc-3-default
@@ -5,6 +5,9 @@
 # Major version of Bootstrap: 3 or 4
 bootstrapVersion: 3
 
+# If Bootstrap version 3 is used - turn on/off custom icon font path
+useCustomIconFontPath: false
+
 # Webpack loaders, order matters
 styleLoaders:
   - style

diff --git a/README.md b/README.md
@@ -218,6 +218,22 @@ scripts:
 scripts: true / false
 ```
 
+#### `useCustomIconFontPath`
+
+Default: false
+
+If you're using a custom icon font and you need to specify its path (`$icon-font-path`) in your Sass files, set this option to true.
+
+```yaml
+useCustomIconFontPath: true / false
+```
+
+```
+$icon-font-path: ../fonts // relative to your Sass file
+$icon-font-name: 'glyphicons' // you'll typically want to change this too.
+```
+
+
 ### Bootstrap 4
 There is only one additional option for Bootstrap 4:
 

diff --git a/examples/basic/.bootstraprc b/examples/basic/.bootstraprc
@@ -5,6 +5,9 @@
 # Major version of Bootstrap: 3 or 4
 bootstrapVersion: 3
 
+# If Bootstrap version 3 is used - turn on/off custom icon font path
+useCustomIconFontPath: false
+
 # Webpack loaders, order matters
 styleLoaders:
   - style

diff --git a/examples/basic/.bootstraprc-3-example b/examples/basic/.bootstraprc-3-example
@@ -5,6 +5,9 @@
 # Major version of Bootstrap: 3 or 4
 bootstrapVersion: 3
 
+# If Bootstrap version 3 is used - turn on/off custom icon font path
+useCustomIconFontPath: false
+
 # Webpack loaders, order matters
 styleLoaders:
   - style

diff --git a/examples/basic/app/styles/bootstrap/pre-customizations.scss b/examples/basic/app/styles/bootstrap/pre-customizations.scss
@@ -19,3 +19,8 @@ $fonts-url-path: '../fonts';
 // $font-size-base:          14px !default;
 // $font-size-large:         ceil(($font-size-base * 1.25)) !default; // ~18px
 // $font-size-small:         ceil(($font-size-base * 0.85)) !default; // ~12px
+
+// If you're using a custom icon font path, specify it as follows
+// $icon-font-path: ../fonts // This path is relative to this file
+// $icon-font-name: 'glyphicons' // The name of the font you want to use
+// And be sure to set useCustomIconFontPath to true in .bootstraprc.
diff --git a/examples/css-modules/.bootstraprc b/examples/css-modules/.bootstraprc
@@ -5,6 +5,9 @@
 # Major version of Bootstrap: 3 or 4
 bootstrapVersion: 3
 
+# If Bootstrap version 3 is used - turn on/off custom icon font path
+useCustomIconFontPath: false
+
 # Webpack loaders, order matters
 styleLoaders:
   - style

diff --git a/examples/css-modules/.bootstraprc-3-example b/examples/css-modules/.bootstraprc-3-example
@@ -5,6 +5,9 @@
 # Major version of Bootstrap: 3 or 4
 bootstrapVersion: 3
 
+# If Bootstrap version 3 is used - turn on/off custom icon font path
+useCustomIconFontPath: false
+
 # Webpack loaders, order matters
 styleLoaders:
   - style

diff --git a/examples/css-modules/app/assets/styles/bootstrap/pre-customizations.scss b/examples/css-modules/app/assets/styles/bootstrap/pre-customizations.scss
@@ -12,3 +12,8 @@ $fonts-url-path: '../../fonts';
   src: url('#{$fonts-url-path}/OpenSans-Light.ttf') format('truetype');
 
 }
+
+// If you're using a custom icon font path, specify it as follows
+// $icon-font-path: ../fonts // This path is relative to this file
+// $icon-font-name: 'glyphicons' // The name of the font you want to use
+// And be sure to set useCustomIconFontPath to true in .bootstraprc.