Blog post drafts with tags show up in tags index

[trslater]

Context

When writing a blog, drafts should be completely hidden from the user, so possible future unfinished work is not revealed prematurely. MkDocs Material blog plugin already prevents drafts from being built by default, and these unbuilt posts are also no included in the blog index or categories list.

Bug description

When using the blog and tags plugins together (as outlined in the docs), draft blog posts with tags are included in the tags index, even when they are not built, leading to revealing unfinished work and broken links.

Related links

• Reporting a bug
• Setting up a blog - Material for MkDocs
• Setting up tags - Material for MkDocs

Reproduction

example.zip

Steps to reproduce

1. Build site: mkdocs build
2. Open index.html from site directory in a browser
3. Click on "Tags" in the navigation

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction.

[squidfunk]

Thanks for reporting! Clearly, that shouldn't happen.

[squidfunk]

Fixed in 15c024c. Thanks for this very concise issue and perfect reproduction, that made fixing this bug a pleasure! The blog plugin will now mark posts that are marked as draft as excluded. The tags plugin will skip excluded pages. Additionally:

• mkdocs serve, by default, renders drafts, which will also appear in the tags index
• mkdocs build, by default, excludes drafts, which will now also be excluded from the tags index

This behavior can be changed with the draft and draft_on_serve settings. We're keeping the page in the index if drafts are rendered for consistency. Nonetheless, this issue can be considered resolved.

We're using the new File.inclusion feature, so please make sure that you're on MkDocs 1.5+.

[trslater]

Fixed in 15c024c. Thanks for this very concise issue and perfect reproduction, that made fixing this bug a pleasure! The blog plugin will now mark posts that are marked as draft as excluded. The tags plugin will skip excluded pages. Additionally:

• mkdocs serve, by default, renders drafts, which will also appear in the tags index
• mkdocs build, by default, excludes drafts, which will now also be excluded from the tags index

This behavior can be changed with the draft and draft_on_serve settings. We're keeping the page in the index if drafts are rendered for consistency. Nonetheless, this issue can be considered resolved.

We're using the new File.inclusion feature, so please make sure that you're on MkDocs 1.5+.

No problem! Thanks for creating such an awesome theme.

[squidfunk]

Released as part of 9.2.0.