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

Merge pull request #3258 from mkdocs/dirtag

Browse Source 
Add YAML placeholder tags that resolve to current paths
This commit is contained in:
Oleh Prypin
2023-07-01 15:42:29 +02:00
committed by GitHub
parent 25f4ea1533 99a9a90553
commit efe5bfbc47
12 changed files with 327 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dev-guide/plugins.md
View File

@@ -110,7 +110,7 @@ class MyPlugin(mkdocs.plugins.BasePlugin):
> from mkdocs.config import base, config_options as c
>
> class _ValidationOptions(base.Config):
> enable = c.Type(bool, default=True)
> enabled = c.Type(bool, default=True)
> verbose = c.Type(bool, default=False)
> skip_checks = c.ListOfItems(c.Choice(('foo', 'bar', 'baz')), default=[])
>
@@ -130,7 +130,7 @@ class MyPlugin(mkdocs.plugins.BasePlugin):
> my_plugin:
> definition_file: configs/test.ini # relative to mkdocs.yml
> validation:
> enable: !ENV [CI, false]
> enabled: !ENV [CI, false]
> verbose: true
> skip_checks:
> - foo