Skip to content

Commit ae4a949

Browse files
committed
Add SASS_PATH instructions to Sass stylesheet docs
A bunch of issues popped up with people asking how to have SASS/SCSS imports the way the would expect normally. Turns out `node-sass` supports the SASS_PATH variable that we can use. This PR adds that to the documentation.
1 parent 5352a0c commit ae4a949

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docusaurus/docs/adding-a-sass-stylesheet.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,20 @@ This will allow you to do imports like
3030
@import '~nprogress/nprogress'; // importing a css file from the nprogress node module
3131
```
3232

33-
> **Tip:** You can opt into using this feature with [CSS modules](adding-a-css-modules-stylesheet.md) too!
34-
3533
> **Note:** You must prefix imports from `node_modules` with `~` as displayed above.
3634
35+
`node-sass` also supports the `SASS_PATH` variable.
36+
37+
To use imports relative to a path you specify, and from `node_modules` without adding the `~` prefix, you can add a [`.env` file](https://github.com/facebook/create-react-app/blob/master/docusaurus/docs/adding-custom-environment-variables.md#adding-development-environment-variables-in-env) at the project root with the variable `SASS_PATH=node_modules:src`. To specify more directories you can add them to `SASS_PATH` separated by a `:` like `path1:path2:path3`.
38+
39+
If you set `SASS_PATH=node_modules:src`, this will allow you to do imports like
40+
```scss
41+
@import 'styles/colors'; // assuming a styles directory under src/, where _colors.scss partial file exists.
42+
@import 'nprogress/nprogress'; // importing a css file from the nprogress node module
43+
```
44+
45+
> **Tip:** You can opt into using this feature with [CSS modules](adding-a-css-modules-stylesheet.md) too!
46+
3747
> **Note:** If you're using Flow, override the [module.file_ext](https://flow.org/en/docs/config/options/#toc-module-file-ext-string) setting in your `.flowconfig` so it'll recognize `.sass` or `.scss` files. You will also need to include the `module.file_ext` default settings for `.js`, `.jsx`, `.mjs` and `.json` files.
3848
>
3949
> ```

0 commit comments

Comments
 (0)