From e4298bb58287459afb3e1c48200a8684d1eae64c Mon Sep 17 00:00:00 2001 From: Shub Date: Wed, 23 Nov 2022 23:26:05 +0530 Subject: [PATCH] doc: update user-guide for plugins config --- docs/user-guide/configure.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/user-guide/configure.md b/docs/user-guide/configure.md index 4fb0e6c8a7..9223105bdc 100644 --- a/docs/user-guide/configure.md +++ b/docs/user-guide/configure.md @@ -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.