A mkdocs plugin that excludes files based on a list of frontmatter tags from being included in the final mkdocs output.
Project description
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
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs-exclude-tagged-files-1.0.4.tar.gz
.
File metadata
- Download URL: mkdocs-exclude-tagged-files-1.0.4.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c1ddfd0c9a0db611d048bf3d6cc854ce6e2360bb4b702696165258db2c664ad |
|
MD5 | 96982cfd628ffaba2b96f0a1672aba50 |
|
BLAKE2b-256 | 9b26e6ddb20677b566ac4ca49801cee0525506c761b0f68c27790a9175c2fe35 |
File details
Details for the file mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 443f73797804b1432a02adac41c06113625579498c85a3db93a8c4b0fcd861b8 |
|
MD5 | d8b17dc64a5fbc679a257bc931a5151b |
|
BLAKE2b-256 | ac2c976fe3241c17ad97a3887695f19eb77007c8d4cce9052b5a3d228c6482ef |