Skip to content

Commit c7e2ae0

Browse files
committed
Add default fork versions.
1 parent e10aa22 commit c7e2ae0

File tree

4 files changed

+725
-3
lines changed

4 files changed

+725
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ __Approach 1:__ Download and use normalize-scss as a starting point for your own
5757
1. Copy the normalize-scss files to your sass directory so that you can alter it
5858
as you include it in your project. To aid with this method, normalize-scss
5959
includes several ready-made "fork" versions:
60-
* fork-versions/default - Fork for libSass / Ruby Sass
60+
* [fork-versions/default](fork-versions/default) - Fork for libSass or Ruby Sass
6161
* [fork-versions/ruby-sass-compass](fork-versions/ruby-sass-compass) - Fork for Ruby Sass with Compass
62-
* fork-versions/typey - Fork for node-sass with Typey
63-
* fork-versions/typey-kss - Fork for node-sass with Typey and KSS comments
62+
* fork-versions/typey - Fork with Typey
63+
* fork-versions/typey-kss - Fork with Typey and KSS comments
6464
2. The normalize-scss code uses the `support-for` module, so add it
6565

6666
__Approach 2:__ Install and include normalize-scss untouched and then build upon it, overriding the defaults later in your Sass when necessary. Just import normalize-scss like any normal Sass module by:

fork-versions/default/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Fork-able normalize-scss<br> for libSass or Ruby Sass
2+
3+
## Using with node-sass
4+
5+
1. Copy these files to your Sass project.
6+
2. This fork-able version requires the [support-for](https://github.com/JohnAlbin/support-for) Sass module. Add it to your package.json with: `npm install --save-dev support-for`
7+
3. Add support-for's `sass` directory to your nodeSass' [`includePaths` option](https://github.com/sass/node-sass#includepaths).
8+
9+
```js
10+
var sass = require('node-sass'),
11+
path = require('path');
12+
13+
sass.render({
14+
file: scss_filename,
15+
includePaths: [
16+
path.join(__dirname, 'node_modules/support-for/sass')
17+
]
18+
}, function(err, result) { /*...*/ });
19+
```
20+
21+
## Using with libSass
22+
23+
If you are not using node-sass with libSass, you probably already know how to include 3rd party libraries into your Sass project.
24+
25+
1. Copy these files to your Sass project.
26+
2. This fork-able version requires the [support-for]() Sass module. Add support-for's `sass` directory to your libSass include paths in the "usual way".
27+
28+
## Using with Ruby Sass
29+
30+
In addition to copying these files to your Sass project, you'll also need to:
31+
32+
1. Edit your `Gemfile` file to add:
33+
34+
```ruby
35+
gem 'support-for', '~> 1.0'
36+
```
37+
38+
2. If you use Compass, edit your `config.rb` file to add:
39+
40+
```ruby
41+
require 'support-for'
42+
```
43+
44+
3. Update your local Gems with: `bundle install`

0 commit comments

Comments
 (0)