mkdocs-exclude-tagged-files

Name	mkdocs-exclude-tagged-files JSON
Version	1.0.4 JSON
	download
home_page	https://github.com/JonasDoesThings/mkdocs-exclude-tagged-files
Summary	A mkdocs plugin that excludes files based on a list of frontmatter tags from being included in the final mkdocs output.
upload_time	2023-09-10 15:21:08
maintainer
docs_url	None
author	Jonas Lorenz <jonas@jonasdoesthings.com>
requires_python
license	MIT
keywords	mkdocs mkdocs-plugin
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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:
```yaml
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:
```markdown
---
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`.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/JonasDoesThings/mkdocs-exclude-tagged-files",
    "name": "mkdocs-exclude-tagged-files",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "mkdocs,mkdocs-plugin",
    "author": "Jonas Lorenz <jonas@jonasdoesthings.com>",
    "author_email": "jonas@jonasdoesthings.com",
    "download_url": "https://files.pythonhosted.org/packages/9b/26/e6ddb20677b566ac4ca49801cee0525506c761b0f68c27790a9175c2fe35/mkdocs-exclude-tagged-files-1.0.4.tar.gz",
    "platform": null,
    "description": "# MKDocs Exclude Tagged Files\nA simple plugin for excluding files from being included in the mkdocs output based on tags in their frontmatter.\n\n## Installation\nRun `pip install --upgrade mkdocs-exclude-tagged-files`\n\n## Configuration\nBasic Configuration in the `mkdocs.yml` file:\n```yaml\nplugins:\n  - mkdocs_exclude_tagged_files:\n      tags_to_exclude: [\"confidential\", \"excluded\"]\n```\nThis configuration will exclude all files that have one of the tags \"confidential\" or \"excluded\" in their frontmatter.  \nFor example this file will be excluded:\n```markdown\n---\ntags: [\"confidential\", \"someothertag\"]\n---\n# Content\n```\n\nBy default, the plugin strips leading `#`-symbols from tags, so the tag `#excluded` will be treated the same as `excluded`.   \nIf you want to disable this behavior set the config value `strip_leading_hashtags` to `false`.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A mkdocs plugin that excludes files based on a list of frontmatter tags from being included in the final mkdocs output.",
    "version": "1.0.4",
    "project_urls": {
        "Homepage": "https://github.com/JonasDoesThings/mkdocs-exclude-tagged-files"
    },
    "split_keywords": [
        "mkdocs",
        "mkdocs-plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac2c976fe3241c17ad97a3887695f19eb77007c8d4cce9052b5a3d228c6482ef",
                "md5": "d8b17dc64a5fbc679a257bc931a5151b",
                "sha256": "443f73797804b1432a02adac41c06113625579498c85a3db93a8c4b0fcd861b8"
            },
            "downloads": -1,
            "filename": "mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d8b17dc64a5fbc679a257bc931a5151b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3901,
            "upload_time": "2023-09-10T15:21:06",
            "upload_time_iso_8601": "2023-09-10T15:21:06.751960Z",
            "url": "https://files.pythonhosted.org/packages/ac/2c/976fe3241c17ad97a3887695f19eb77007c8d4cce9052b5a3d228c6482ef/mkdocs_exclude_tagged_files-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b26e6ddb20677b566ac4ca49801cee0525506c761b0f68c27790a9175c2fe35",
                "md5": "96982cfd628ffaba2b96f0a1672aba50",
                "sha256": "1c1ddfd0c9a0db611d048bf3d6cc854ce6e2360bb4b702696165258db2c664ad"
            },
            "downloads": -1,
            "filename": "mkdocs-exclude-tagged-files-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "96982cfd628ffaba2b96f0a1672aba50",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3140,
            "upload_time": "2023-09-10T15:21:08",
            "upload_time_iso_8601": "2023-09-10T15:21:08.332445Z",
            "url": "https://files.pythonhosted.org/packages/9b/26/e6ddb20677b566ac4ca49801cee0525506c761b0f68c27790a9175c2fe35/mkdocs-exclude-tagged-files-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-10 15:21:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "JonasDoesThings",
    "github_project": "mkdocs-exclude-tagged-files",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "mkdocs-exclude-tagged-files"
}