plugins

Configure custom plugins to extend lint and decorator behavior. Use a plugin when the built-in rules, configurable rules, and built-in decorators do not cover your needs. To learn how to write one, see custom plugins.

The plugins option is a list of paths to plugin files. Paths are relative to the config file. Add as many plugins as you need.

The following example includes two plugins from a directory named plugins/:

plugins:
  - plugins/my-best-plugin.js
  - plugins/another-plugin.js

List a plugin in the plugins section first. Then you can use its content elsewhere in the configuration file.

• APIs configuration - Set options per API in redocly.yaml
• Rules configuration - Define the lint rules your plugins work with
• Decorators - Transform your OpenAPI documents
• Redocly CLI cookbook - Practical examples of plugins from real projects
• Configuration options - All the other options for your project