dariuszporowski / mkdocs-file-filter-plugin Goto Github PK

🐛 What happened?

Pages are not excluded when include_tag is used - apparently only exclude_tag works

🔬 How to reproduce?

Configure as such:

theme:
  name: material

plugins:
  - file-filter:
      filter_nav: false
      metadata_property: visibility
      include_tag:
        - public

  - search
  - awesome-pages
  - ezlinks
  - tags:
      tags_file: tags.md

Create a page with this frontmatter:

visibility: public

The page will still be included in the build website.

🏗️ Code Sample / Log

No response

🌌 Environment (plugin version)

0.2.0

🌌 Environment (OS)

Linux

🌌 Environment (Python)

3.11.1

🌌 Environment (MkDocs)

1.5.3

📷 Screenshots

No response

📈 Expected behavior

Error 404 when trying to access the "private" page i.e. any page WITHOUT the visibility:public in the frontmatter

📎 Additional context

No response

📜 Code of Conduct

• I agree to follow this project's Code of Conduct.

due to wrong return in judger

🚀 Feature description

filter_nav_tag (array of strings) to filter out Markdown pages which have select tags, but only from navigation (eg. actually render them, but have them hidden). This behaviour should only be applied if filter_nav: true.

🔈 Motivation

Subpages that should not be rendered in navigation to prevent clutter. Or easter eggs. Or "private-ish" pages.

🛰 Alternatives

Defining nav by myself: Tedious, manual, not really feasible if I just want to work on the documentation contents.
awesome-pages: Less manual, but still it can only filter out entire directories and not single files.

📎 Additional context

Not really applicable, I outlined the context on the motivation section.

📜 Code of Conduct

• I agree to follow this project's Code of Conduct.

🐛 What happened?

When I build my project, I get these log lines:

INFO    -  DeprecationWarning: warning_filter doesn't do anything since MkDocs 1.2
and will be removed soon. All messages on the `mkdocs` logger get counted
automatically.

they originate from mkdocs_file_filter_plugin/logger.py

🔬 How to reproduce?

1. have a mkdocs 1.2+ project (1.5.1 in my case)
2. configure it to use file-filter
3. run mkdocs serve

🏗️ Code Sample / Log

INFO    -  DeprecationWarning: warning_filter doesn't do anything since MkDocs 1.2 and will be removed soon. All messages on the `mkdocs` logger get counted automatically.

🌌 Environment (plugin version)

0.1.0

🌌 Environment (OS)

Linux

🌌 Environment (Python)

3.10.12

🌌 Environment (MkDocs)

1.5.1

📷 Screenshots

No response

📈 Expected behavior

I would expect this not throwing any warnings.

📎 Additional context

No response

📜 Code of Conduct

• I agree to follow this project's Code of Conduct.