1 | # stylelint-config-suitcss
|
2 | [![NPM version](http://img.shields.io/npm/v/stylelint-config-suitcss.svg)](https://www.npmjs.org/package/stylelint-config-suitcss) [![Travis Build Status](https://img.shields.io/travis/stylelint/stylelint-config-suitcss/master.svg?label=unix%20build)](https://travis-ci.org/stylelint/stylelint-config-suitcss) [![AppVeyor Build Status](https://img.shields.io/appveyor/ci/jeddy3/stylelint-config-suitcss/master.svg?label=windows%20build)](https://ci.appveyor.com/project/jeddy3/stylelint-config-suitcss)
|
3 |
|
4 | > SuitCSS shareable config for stylelint.
|
5 |
|
6 | Configuration rules to ensure your CSS code is compliant with [SuitCSS's code style](https://github.com/suitcss/suit/blob/master/doc/STYLE.md).
|
7 |
|
8 | ## Installation
|
9 |
|
10 | ```console
|
11 | $ npm install stylelint-config-suitcss
|
12 | ```
|
13 |
|
14 | ## Usage
|
15 |
|
16 | Set your stylelint config to:
|
17 |
|
18 | ```json
|
19 | {
|
20 | "extends": "stylelint-config-suitcss"
|
21 | }
|
22 | ```
|
23 |
|
24 | ### Extending the config
|
25 |
|
26 | Simply add a `"rules"` key to your config and add your overrides there.
|
27 |
|
28 | For example, to change the `indentation` to tabs and turn off the `number-leading-zero` rule:
|
29 |
|
30 |
|
31 | ```json
|
32 | {
|
33 | "extends": "stylelint-config-suitcss",
|
34 | "rules": {
|
35 | "indentation": [2, "tab"],
|
36 | "number-leading-zero": 0
|
37 | }
|
38 | }
|
39 | ```
|
40 |
|
41 | ## [Changelog](CHANGELOG.md)
|
42 |
|
43 | ## [License](LICENSE)
|