MKDocs Exclude Tagged Files
A simple plugin for excluding files from being included in the mkdocs output based on tags in their frontmatter.
Installation
Run pip install --upgrade mkdocs-exclude-tagged-files
Configuration
Basic Configuration in the mkdocs.yml file:
plugins:
- mkdocs_exclude_tagged_files:
tags_to_exclude: ["confidential", "excluded"]
This configuration will exclude all files that have one of the tags "confidential" or "excluded" in their frontmatter.
For example this file will be excluded:
---
tags: ["confidential", "someothertag"]
---
# Content
By default, the plugin strips leading #-symbols from tags, so the tag #excluded will be treated the same as excluded.
If you want to disable this behavior set the config value strip_leading_hashtags to false.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-exclude-tagged-files 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-exclude-tagged-files-1.0.4.tar.gz | 3.1 kB | Without provenance | Details for mkdocs-exclude-tagged-files-1.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl |
Total release size: 7.0 kB
Release files / mkdocs-exclude-tagged-files-1.0.4.tar.gz
| Download URL | mkdocs-exclude-tagged-files-1.0.4.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c1ddfd0c9a0db611d048bf3d6cc854ce6e2360bb4b702696165258db2c664ad
|
|
BLAKE2b-256 checksum How to use checksums |
9b26e6ddb20677b566ac4ca49801cee0525506c761b0f68c27790a9175c2fe35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.2
|
Release files / mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl
| Download URL | mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
443f73797804b1432a02adac41c06113625579498c85a3db93a8c4b0fcd861b8
|
|
BLAKE2b-256 checksum How to use checksums |
ac2c976fe3241c17ad97a3887695f19eb77007c8d4cce9052b5a3d228c6482ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.2
|
Security for mkdocs-exclude-tagged-files 1.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
