Skip to content

Commit 2058020

Browse files
committed
Update README
Documentation around stylelint-config-suitcss usage
1 parent b6b1cdb commit 2058020

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -102,32 +102,23 @@ Where to resolve imports from. Passed to [`postcss-import`](https://github.com/p
102102
Ensure code conforms to the [SUIT code style](https://github.com/suitcss/suit/blob/master/doc/STYLE.md)
103103
by using the [stylelint-config-suitcss](https://github.com/suitcss/stylelint-config-suitcss) package.
104104

105-
Stylelint [configuration options](http://stylelint.io/?/docs/user-guide/configuration.md) can also be overridden:
105+
Stylelint [configuration
106+
options](http://stylelint.io/?/docs/user-guide/configuration.md) can also be
107+
overridden but this requires the `stylelint-config-suitcss` to be installed
108+
locally in your package.
106109

107110
```js
108111
{
109112
lint: true,
110113
stylelint: {
111-
extends: 'stylelint-config-suitcss',
114+
extends: 'stylelint-config-suitcss',
112115
rules: {
113116
indentation: [4, 'tab'],
114117
}
115118
}
116119
}
117120
```
118121

119-
The preprocessor will also pick up any rules added to a `.stylelintrc` in your
120-
project root. For example:
121-
122-
123-
```js
124-
{
125-
"extends": "stylelint-config-suitcss"
126-
}
127-
```
128-
129-
**Note**: This works the same with the CLI `-l` flag.
130-
131122
##### `minify`
132123

133124
* Type: `Boolean`

0 commit comments

Comments
 (0)