Skip to content

Commit f6e624a

Browse files
authored
docs: update note in README.md (#1067)
1 parent 2e1822e commit f6e624a

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

+30-10
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,17 @@ pnpm add -D sass-loader sass webpack
4242

4343
This allows you to control the versions of all your dependencies, and to choose which Sass implementation to use.
4444

45-
> ℹ️ We highly recommend using [Dart Sass](https://github.com/sass/dart-sass).
45+
> **Note**
46+
>
47+
> We highly recommend using [Dart Sass](https://github.com/sass/dart-sass).
4648
47-
> [Node Sass](https://github.com/sass/node-sass) does not work with [Yarn PnP](https://classic.yarnpkg.com/en/docs/pnp/) feature and doesn't support [@use rule](https://sass-lang.com/documentation/at-rules/use).
49+
> **Warning**
50+
>
51+
> [Node Sass](https://github.com/sass/node-sass) does not work with [Yarn PnP](https://classic.yarnpkg.com/en/docs/pnp/) feature and doesn't support [@use rule](https://sass-lang.com/documentation/at-rules/use).
4852
49-
> [Sass Embedded](https://github.com/sass/embedded-host-node) is experimental and in `beta`, therefore some features may not work
53+
> **Warning**
54+
>
55+
> [Sass Embedded](https://github.com/sass/embedded-host-node) is experimental and in `beta`, therefore some features may not work
5056
5157
Chain the `sass-loader` with the [css-loader](https://github.com/webpack-contrib/css-loader) and the [style-loader](https://github.com/webpack-contrib/style-loader) to immediately apply all styles to the DOM or the [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) to extract it into a separate file.
5258

@@ -334,15 +340,23 @@ Default: defaults values for Sass implementation
334340

335341
Options for [Dart Sass](http://sass-lang.com/dart-sass) or [Node Sass](https://github.com/sass/node-sass) implementation.
336342

337-
> ℹ️ The `charset` option has `true` value by default for `dart-sass`, we strongly discourage change value to `false`, because webpack doesn't support files other than `utf-8`.
343+
> **Note**
344+
>
345+
> The `charset` option has `true` value by default for `dart-sass`, we strongly discourage change value to `false`, because webpack doesn't support files other than `utf-8`.
338346
339-
> ℹ️ The `indentedSyntax` option has `true` value for the `sass` extension.
347+
> **Note**
348+
>
349+
> The `indentedSyntax` option has `true` value for the `sass` extension.
340350
341-
> ℹ️ Options such as `data` and `file` are unavailable and will be ignored.
351+
> **Note**
352+
>
353+
> Options such as `data` and `file` are unavailable and will be ignored.
342354
343355
> ℹ We strongly discourage change `outFile`, `sourceMapContents`, `sourceMapEmbed`, `sourceMapRoot` options because `sass-loader` automatically sets these options when the `sourceMap` option is `true`.
344356
345-
> ℹ️ Access to the [loader context](https://webpack.js.org/api/loaders/#the-loader-context) inside the custom importer can be done using the `this.webpackLoaderContext` property.
357+
> **Note**
358+
>
359+
> Access to the [loader context](https://webpack.js.org/api/loaders/#the-loader-context) inside the custom importer can be done using the `this.webpackLoaderContext` property.
346360
347361
There is a slight difference between the `sass` (`dart-sass`) and `node-sass` options.
348362

@@ -661,7 +675,9 @@ Default: `false`
661675

662676
Treats the `@warn` rule as a webpack warning.
663677

664-
> ℹ️ It will be `true` by default in the next major release.
678+
> **Note**
679+
>
680+
> It will be `true` by default in the next major release.
665681
666682
**style.scss**
667683

@@ -725,9 +741,13 @@ Default: `"legacy"`
725741

726742
Allows you to switch between `legacy` and `modern` API. You can find more information [here](https://sass-lang.com/documentation/js-api).
727743

728-
> ⚠ "modern" API is experimental, so some features may not work (known: built-in `importer` is not working and files with errors is not watching on initial run), you can follow this [here](https://github.com/webpack-contrib/sass-loader/issues/774).
744+
> **Warning**
745+
>
746+
> "modern" API is experimental, so some features may not work (known: built-in `importer` is not working and files with errors is not watching on initial run), you can follow this [here](https://github.com/webpack-contrib/sass-loader/issues/774).
729747
730-
> ⚠ The sass options are different for `modern` and `old` APIs. Please look at [docs](https://sass-lang.com/documentation/js-api) how to migrate on new options.
748+
> **Warning**
749+
>
750+
> The sass options are different for `modern` and `old` APIs. Please look at [docs](https://sass-lang.com/documentation/js-api) how to migrate on new options.
731751
732752
**webpack.config.js**
733753

0 commit comments

Comments
 (0)