mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-07 20:57:49 +00:00
17b73c1723
* docs: Add resolve config reference * docs: Start API reference, needs child config entries * docs: Add sidebar entries for config reference pages * docs: Add rules and decorators config pages * docs: Fix links and format * docs: Fix links and formatting * docs: Add extends and plugins config reference pages * docs: Add a basic preprocessor page * docs: Update from review feedback * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: Reformat required labels * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: Fix misspelling --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com>
1.3 KiB
1.3 KiB
plugins
Introduction
Redocly supports custom plugins for extending lint and decorator behavior. Use plugins when you need to add rules beyond the built-in and configurable, or decorators beyond the built-in decorators.
Options
The plugins configuration is an array of paths to plugin files, relative to the config file.
You can include as many plugins as you need.
Examples
A basic example of including two plugins from a directory named plugins/ is shown in the example below:
plugins:
- plugins/my-best-plugin.js
- plugins/another-plugin.js
Remember that you need to include plugins in the plugins section before you can use the content of the plugin elsewhere in the configuration file.
Related options
- apis configuration options allow setting per-API configuration in
redocly.yaml. - rules settings define the linting rules that are used.
- decorators offer some transformations for your OpenAPI documents.
Resources
- The Redocly CLI cookbook has many examples of plugins.
- Read more configuration examples.