Skip to content

Commit ca0134f

Browse files
committed
Add a note in the readme to avoid sprockets directives.
1 parent ca9e529 commit ca0134f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.markdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ properties that will be passed to Sass.
2121
config.sass.syntax = :nested
2222
end
2323

24+
### Important Note
25+
26+
Sprockets provides some directives that are placed inside of comments called `require`, `require_tree`, and
27+
`require_self`. **DO NOT USE THEM IN YOUR SASS/SCSS FILES.** They are very primitive and
28+
do not work well with Sass files. Instead, use Sass's native `@import`
29+
directive which `sass-rails` has customized to integrate with the
30+
conventions of your rails projects.
31+
2432
### Options
2533

2634
The [list of supported options](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options) can be found on the Sass Website with the following caveats:
@@ -67,4 +75,4 @@ The [list of supported options](http://sass-lang.com/docs/yardoc/file.SASS_REFER
6775
$ bundle install
6876
$ bundle exec rake test
6977

70-
If you need to test against local gems, use Bundler's gem :path option in the Gemfile and also edit `test/support/test_helper.rb` and tell the tests where the gem is checked out.
78+
If you need to test against local gems, use Bundler's gem :path option in the Gemfile and also edit `test/support/test_helper.rb` and tell the tests where the gem is checked out.

0 commit comments

Comments
 (0)