Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add project: mkdocs-required-frontmatter-plugin #199

Merged
merged 2 commits into from
Mar 22, 2024

Conversation

james-geiger
Copy link
Contributor

What kind of change does this PR introduce?

  • Add a project
  • Update a project
  • Remove a project
  • Add or update a category
  • Change configuration
  • Documentation
  • Other, please describe:

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:

  • I have read the CONTRIBUTING guidelines.
  • I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Mar 22, 2024

Thanks! There's just an issue with the blank line: you seem to have removed it. Please maintain blank lines between catégories :)

Copy link
Sponsor Collaborator

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thanks!

@pawamoy pawamoy merged commit 2f85400 into mkdocs:main Mar 22, 2024
1 check passed
@james-geiger
Copy link
Contributor Author

Thanks, @pawamoy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants