Skip to content

Commit 2c98114

Browse files
committed
Improve docs on using as a module
1 parent 72ce5c5 commit 2c98114

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ In the below imports, replace `:file` with one of the options below:
126126
- `checka11y.css` <small>(.css file)</small>
127127
- `src/errors/checka11y-errors` <small>(errors **only**)</small>
128128
- `src/warnings/checka11y-warnings` <small>(warnings **only**)</small>
129+
130+
Use as a Sass module <small>(recommended)</small>:
129131
```scss
130132
/* Webpack */
131133
@use '~checka11y-css/:file' as *;
@@ -134,6 +136,15 @@ In the below imports, replace `:file` with one of the options below:
134136
@use 'path/to/node_modules/checka11y-css/:file' as *;
135137
```
136138

139+
Import generally <small>(not recommended, <a href="https://sass-lang.com/documentation/at-rules/import">read why</a>)</small>:
140+
```scss
141+
/* Webpack */
142+
@import '~checka11y-css/:file';
143+
144+
/* Non-webpack */
145+
@import 'path/to/node_modules/checka11y-css/:file';
146+
```
147+
137148
### Using Angular?
138149

139150
👉 [Go to ngx-checka11y](https://github.com/AlaaEl-DinAhmed/ngx-checka11y)

0 commit comments

Comments
 (0)