Add project: mkdocs-required-frontmatter-plugin #199
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Description:
This PR adds the project mkdocs-required-frontmatter-plugin. This plugin adds a hook on generation that enforces required YAML front matter for all documentation. This can be helpful to enforce consistency across project maintainers or when build processes (particularly those outside MkDocs) further process documentation.
Checklist:
README.md
file. Projects are only supposed to be added or updated within theprojects.yaml
file since theREADME.md
file is automatically generated.