Skip to content

Commit 4ba7cc3

Browse files
authored
Merge pull request #221 from nuxt-community/docs/update-readme
docs: rewrite to config for nuxt 3
2 parents 7a0fa3d + deb83f3 commit 4ba7cc3

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Use this module only to import variables, mixins, functions (et cetera) as they
3131
## Setup
3232

3333
- If not already present, add the dependencies you need for SASS/LESS/Stylus (depending on your needs)
34-
- SASS: `yarn add sass-loader sass` (for Nuxt 2 use: ``sass-loader@10``)
34+
- SASS: `yarn add sass-loader sass`
3535
- LESS: `yarn add less-loader less`
3636
- Stylus: `yarn add stylus-loader stylus`
3737
- Add `@nuxtjs/style-resources` dependency using yarn or npm to your project (`yarn add -D @nuxtjs/style-resources`)
38-
- Add `@nuxtjs/style-resources` to `buildModules` section of `nuxt.config.js`:
38+
- Add `@nuxtjs/style-resources` to `modules` section of `nuxt.config.ts`:
3939

40-
```js
41-
export default {
42-
buildModules: [
40+
```ts
41+
export default defineNuxtConfig({
42+
modules: [
4343
'@nuxtjs/style-resources',
4444
],
4545

@@ -51,22 +51,22 @@ export default {
5151
stylus: [],
5252
hoistUseStatements: true // Hoists the "@use" imports. Applies only to "sass", "scss" and "less". Default: false.
5353
}
54-
}
54+
})
5555
```
5656

5757
## Examples
5858

5959
### LESS Example
6060

61-
`nuxt.config.js`:
61+
`nuxt.config.ts`:
6262
```js
63-
export default {
63+
export default defineNuxtConfig({
6464
css: ['~assets/global.less'],
65-
buildModules: ['@nuxtjs/style-resources'],
65+
modules: ['@nuxtjs/style-resources'],
6666
styleResources: {
6767
less: './assets/vars/*.less'
6868
}
69-
}
69+
})
7070
```
7171

7272
`assets/global.less`
@@ -127,17 +127,17 @@ export default {
127127

128128
### SCSS Example
129129

130-
`nuxt.config.js`:
130+
`nuxt.config.ts`:
131131
```js
132-
export default {
133-
buildModules: ['@nuxtjs/style-resources'],
132+
export default defineNuxtConfig({
133+
modules: ['@nuxtjs/style-resources'],
134134
styleResources: {
135135
scss: [
136136
'./assets/vars/*.scss',
137137
'./assets/abstracts/_mixins.scss' // use underscore "_" & also file extension ".scss"
138138
]
139139
}
140-
}
140+
})
141141
```
142142

143143
> Instead of `'./assets/abstracts/_mixins.scss'` you can use also `'~assets/abstracts/_mixins.scss'`

0 commit comments

Comments
 (0)