# File exclude plugin for mkdocs
`mkdocs-exclude` is a
[mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/) that allows you
to exclude files from your input using unix-style wildcards (globs) or
regular expressions (regexes).
This implements what people were asking for in some mkdocs bugs, such as
<https://github.com/mkdocs/mkdocs/issues/1500> and
<https://github.com/mkdocs/mkdocs/issues/1152>.
## Quick start
1. Install the module using pip: `pip3 install mkdocs-exclude`
2. In your project, add a plugin configuration to `mkdocs.yml`:
```yaml
plugins:
- exclude:
glob:
- exclude/this/path/*
- "*.tmp"
- "*.pdf"
- "*.gz"
regex:
- '.*\.(tmp|bin|tar)$'
```
You can provide zero or more patterns of each type. (If you don't provide
any patterns, then nothing will happen!)
Note! Because of peculiarity of yaml syntax, the `glob:` and `regex:` lines
**must not** start with a dash, but the lines under them **must** start with
a dash.
Also because of yaml, patterns that start with a punctuation mark must be
quoted.
When writing regexes, it's best to use single quotes rather than double
quotes, so that your regex backslash escapes are preserved correctly without
having to be doubled up.
Raw data
{
"_id": null,
"home_page": "https://github.com/apenwarr/mkdocs-exclude",
"name": "mkdocs-exclude",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Avery Pennarun",
"author_email": "apenwarr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/54/b5/3a8e289282c9e8d7003f8a2f53d673d4fdaa81d493dc6966092d9985b6fc/mkdocs-exclude-1.0.2.tar.gz",
"platform": "",
"description": "# File exclude plugin for mkdocs\n\n`mkdocs-exclude` is a\n[mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/) that allows you\nto exclude files from your input using unix-style wildcards (globs) or\nregular expressions (regexes).\n\nThis implements what people were asking for in some mkdocs bugs, such as\n<https://github.com/mkdocs/mkdocs/issues/1500> and\n<https://github.com/mkdocs/mkdocs/issues/1152>.\n\n\n## Quick start\n\n1. Install the module using pip: `pip3 install mkdocs-exclude`\n\n2. In your project, add a plugin configuration to `mkdocs.yml`:\n\n ```yaml\n plugins:\n - exclude:\n glob:\n - exclude/this/path/*\n - \"*.tmp\"\n - \"*.pdf\"\n - \"*.gz\"\n regex:\n - '.*\\.(tmp|bin|tar)$'\n ```\n\nYou can provide zero or more patterns of each type. (If you don't provide\nany patterns, then nothing will happen!)\n\nNote! Because of peculiarity of yaml syntax, the `glob:` and `regex:` lines\n**must not** start with a dash, but the lines under them **must** start with\na dash.\n\nAlso because of yaml, patterns that start with a punctuation mark must be\nquoted.\n\nWhen writing regexes, it's best to use single quotes rather than double\nquotes, so that your regex backslash escapes are preserved correctly without\nhaving to be doubled up.",
"bugtrack_url": null,
"license": "Apache",
"summary": "A mkdocs plugin that lets you exclude files or trees.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/apenwarr/mkdocs-exclude"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54b53a8e289282c9e8d7003f8a2f53d673d4fdaa81d493dc6966092d9985b6fc",
"md5": "b73ad0a6a4fdde5f6e06b8536133c2db",
"sha256": "ba6fab3c80ddbe3fd31d3e579861fd3124513708271180a5f81846da8c7e2a51"
},
"downloads": -1,
"filename": "mkdocs-exclude-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b73ad0a6a4fdde5f6e06b8536133c2db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6751,
"upload_time": "2019-02-20T23:34:12",
"upload_time_iso_8601": "2019-02-20T23:34:12.810099Z",
"url": "https://files.pythonhosted.org/packages/54/b5/3a8e289282c9e8d7003f8a2f53d673d4fdaa81d493dc6966092d9985b6fc/mkdocs-exclude-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-02-20 23:34:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apenwarr",
"github_project": "mkdocs-exclude",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-exclude"
}
JSON
