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 Distributions
Close
Hashes for mkdocs-exclude-tagged-files-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7fd2cf835f0791998fb7ee36457b7f8381c20920e45830a24644a016ceaafd4 |
|
MD5 | d69aab9aebef731219cd1587a7eeb998 |
|
BLAKE2b-256 | dc1c59401b642747bb998fb1911b2437c0ca2f7f293c73b99ba8cf480909d91b |
Close
Hashes for mkdocs_exclude_tagged_files-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87e54f8dbe8ae5228356d99a9779f29f5a07d2fea76d3851611a6d748c0b3060 |
|
MD5 | d27f24f005112e415eccd3da74ab4c76 |
|
BLAKE2b-256 | 36cedeb9e212b08eef64a1188439351ac3ce122bfa550d5efa783f149be5bded |
Close
Hashes for mkdocs_exclude_tagged_files-1.0.1-1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a18e37cfb8ca116cdd6aaa931dca2e34a6ff8746ab078e4e77b6b3326346fbb |
|
MD5 | e9b6f0bb6c7d39bf48e293d467e2bd54 |
|
BLAKE2b-256 | d9dd66e9254bf50e4c8acef28f5675e34b0a6412df58f9bdb3458be90f6971d8 |