Skip to content

Commit

Permalink
Add required-frontmatter plugin.
Browse files Browse the repository at this point in the history
It doesn't seem to actually do anything. Github issue opened: unmc-vcr/mkdocs-required-frontmatter-plugin#1
  • Loading branch information
redjax committed Jan 6, 2025
1 parent ce5eb47 commit 5a7bf17
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
14 changes: 14 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,20 @@ plugins:
validate_rendered_template: True
## Enable offline version of site. Breaks many features.
# - offline
- required-frontmatter:
enabled: true
required-keys:
- tags
- a_test_tag
## Disable required frontmatter on specific files/paths
exclude:
## All index.md files
- index.md
## A path to a directory and file pattern
# - example/path/*
## Fail build when page is missing frontmatter & strict: true
strict: true


markdown_extensions:
## Add footnotes to marked-up abbreviations to provide extra context.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ authors = [{ name = "redjax", email = "[email protected]" }]
license = { text = "MIT" }
dependencies = [
"markdown-include>=0.8.1",
"mkdocs-required-frontmatter-plugin>=0.0.2",
"mkdocs>=1.6.1",
"mkdocs-autorefs>=1.2.0",
"mkdocs-gen-files>=0.5.0",
Expand Down
11 changes: 11 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5a7bf17

Please sign in to comment.