centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add an enabled setting for all plugins (#3395)

Browse Source 
For every plugin, the user can set `enabled: false` (or something based on an environment variable) and it will not kick in at all.

If the plugin has its own `enabled` config, there's no change for it in that case.
This commit is contained in:
Oleh Prypin
2023-10-30 01:58:27 +01:00
committed by GitHub
parent f3d5c8dc8d
commit 7ab01c24ff
3 changed files with 92 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/user-guide/configuration.md
View File

@@ -800,6 +800,8 @@ You might have seen this feature in the [mkdocs-simple-hooks plugin](https://git
A list of plugins (with optional configuration settings) to use when building
the site. See the [Plugins] documentation for full details.
**default**: `['search']` (the "search" plugin included with MkDocs).
If the `plugins` config setting is defined in the `mkdocs.yml` config file, then
any defaults (such as `search`) are ignored and you need to explicitly re-enable
the defaults if you would like to continue using them:
@@ -820,6 +822,30 @@ plugins:
option2: other value
```
To completely disable all plugins, including any defaults, set the `plugins`
setting to an empty list:
```yaml
plugins: []
```
#### `enabled` option
> NEW: **New in MkDocs 1.6.**
>
> Each plugin has its own options keys. However MkDocs also ensures that each plugin has the `enabled` boolean option. This can be used to conditionally enable a particular plugin, as in the following example:
>
> ```yaml
> plugins:
> - search
> - code-validator:
> enabled: !ENV [LINT, false]
> ```
>
> See: [Environment variables](#environment-variables)
#### Alternate syntax
In the above examples, each plugin is a list item (starts with a `-`). As an
alternative, key/value pairs can be used instead. However, in that case an empty
value must be provided for plugins for which no options are defined. Therefore,
@@ -836,15 +862,6 @@ plugins:
This alternative syntax is required if you intend to override some options via
[inheritance].
To completely disable all plugins, including any defaults, set the `plugins`
setting to an empty list:
```yaml
plugins: []
```
**default**: `['search']` (the "search" plugin included with MkDocs).
#### Search
A search plugin is provided by default with MkDocs which uses [lunr.js] as a