Skip to content

Commit

Permalink
doc: update user-guide for plugins config
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenisx committed Nov 23, 2022
1 parent ac83ec7 commit e4298bb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/user-guide/configure.md
Expand Up @@ -234,6 +234,16 @@ To use one, add a `"plugins"` array to your config, containing "locaters" identi
- npm module name
- absolute path
- path relative to the invoking configuration file
- stylelint plugin object of format

```js
{
ruleName: "plugin-name",
rule: function plugin(opts) { /* Plugin Code */ }
}
```

> Read more about writing [Stylint Plugins here](../developer-guide/plugins.md).
Once the plugin is declared, within your `"rules"` object _you'll need to add options_ for the plugin's rule(s), just like any standard rule. Look at the plugin's documentation to know what the rule name should be.

Expand Down

0 comments on commit e4298bb

Please sign in to comment.