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.
Configuration
Basic Configuration:
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
Close
Hashes for mkdocs-exclude-tagged-files-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c9d97c7e58cca76ab4f3be4628ab25019ea9ad2b6370317a80bb58f01534528 |
|
MD5 | 0ae092f2fe1f7d716e464865566d202e |
|
BLAKE2b-256 | b41583cb2779c129f9a371bc5a203b14a92e5d544b00df1ba66dfa2e40e2b68f |
Close
Hashes for mkdocs_exclude_tagged_files-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b38c5e8af2ed18cd3d5f57d5a761f83dd03a6298cc355249b87bfdc692897ee |
|
MD5 | 1099fbda94513698aeb79cdab7b8e956 |
|
BLAKE2b-256 | 0852fe841ec15045e7733a83b4169b93ad644bf76dc428c4a9c9b31a34b060fa |