Skip to content

Commit d94e753

Browse files
tay1orjonestay1orjones
authored
docs(readme): include link to sass FAQ (#14123)
1 parent f3c3523 commit d94e753

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

‎packages/react/README.md‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,35 @@ yarn add @carbon/react
2121
This package requires [Dart Sass](http://npmjs.com/package/sass) in order to
2222
compile styles.
2323

24-
If you're new to Sass, or are wondering how to configure Sass for your project,
25-
we recommend checking out the following resources and links:
24+
If you're new to Sass, we recommend checking out the following resources and
25+
links:
2626

2727
- [Sass Basics](https://sass-lang.com/guide)
28-
- [Webpack with Sass](https://webpack.js.org/loaders/sass-loader/)
28+
- [The Sass `@use` documentation for Sass modules](https://sass-lang.com/documentation/at-rules/use/)
29+
- [The Carbon Design System FAQ on Sass](https://carbondesignsystem.com/migrating/faq/#sass-and-package-management)
30+
31+
For info on how to configure Sass for your project, here are some common
32+
framework's documentation worth reviewing:
33+
2934
- [Next.js with Sass](https://nextjs.org/docs/basic-features/built-in-css-support#sass-support)
30-
- [Create React App with Sass](https://create-react-app.dev/docs/adding-a-sass-stylesheet/)
35+
- [Remix with Sass](https://remix.run/docs/en/1.18.0/guides/styling#css-preprocessors)
36+
- [Gatsby with Sass](https://www.gatsbyjs.com/docs/how-to/styling/sass/)
37+
38+
Or if you're just using a bundler:
39+
3140
- [Parcel with Sass](https://v2.parceljs.org/languages/sass/)
3241
- [Vite with Sass](https://vitejs.dev/guide/features.html#css-pre-processors)
42+
43+
Or anything else not listed above:
44+
45+
- [Webpack with Sass](https://webpack.js.org/loaders/sass-loader/)
46+
- [Create React App with Sass](https://create-react-app.dev/docs/adding-a-sass-stylesheet/)
3347
- [Snowpack with Sass](https://www.snowpack.dev/guides/sass/)
3448

35-
Once you get Sass up and running in your project, configure Sass to include
36-
`node_modules` in its `includePaths` option. For more information, checkout the
37-
[configuration](../styles/docs/sass.md#configuration) section in our Sass docs.
49+
Once you get Sass up and running in your project, you may need to configure Sass
50+
to include `node_modules` in its `includePaths` option. For more information,
51+
checkout the [configuration](../styles/docs/sass.md#configuration) section in
52+
our Sass docs.
3853

3954
## Usage
4055

0 commit comments

Comments
 (0)