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

strict: true is not failing builds on missing frontmatter #1

Open
redjax opened this issue Jan 6, 2025 · 0 comments
Open

strict: true is not failing builds on missing frontmatter #1

redjax opened this issue Jan 6, 2025 · 0 comments

Comments

@redjax
Copy link

redjax commented Jan 6, 2025

Love the idea for this plugin, thank you for building it!

I have added it to my project and added this section to my plugins::

- 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

I added a test required-key, a_test_tag, which none of my pages have. When I run mkdocs build, the site builds without error. I believe this means I've configured it wrong, or something about my setup is causing this plugin not to work.

Let me know what information from me would be helpful for troubleshooting this, and I'm happy to be a guinea pig for any changes :)1

redjax pushed a commit to redjax/redkb that referenced this issue Jan 6, 2025
It doesn't seem to actually do anything. Github issue opened: unmc-vcr/mkdocs-required-frontmatter-plugin#1
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

No branches or pull requests

1 participant