Metadata-Version: 2.1
Name: mkdocs-include-exclude-files
Version: 0.0.1
Summary: Modify which files MkDocs includes or excludes.
Home-page: https://github.com/patrick-kidger/mkdocs_include_exclude_files
Author: Patrick Kidger
Author-email: contact@kidger.site
Maintainer: Patrick Kidger
Maintainer-email: contact@kidger.site
License: Apache-2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs (>=1.2.3)

# mkdocs_include_exclude_files

By default, mkdocs copies everything it can find in the `docs_dir` directory that doesn't start with a `.`

This plugin allows for customising that.

## Installation

```bash
pip install mkdocs_include_exclude_files
```

Requires MkDocs 1.2.3+ and Python 3.8+

## Usage

In `mkdocs.yml`:
```
plugins:
    - search  # default plugin, need to re-enable when using manual plugins
    - include_exclude_files:
        - include:
            - ".some_file"
            - ".anotherfile"
        - exclude
            - "some_folder"
            - "anotherfolder"
```

Every file exactly matching those in `include` will be included. Any file whose location *starts with* anything in `exclude` will be excluded.


