Skip to content

Commit 7ad983d

Browse files
committed
Clarify exclude documentation
1 parent 51ecaf8 commit 7ad983d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,19 @@ More information about plugins in the [MkDocs documentation][mkdocs-plugins].
4848
- `enterprise_hostname` - For GitHub enterprise: the enterprise hostname.
4949
- `docs_path` - the path to the documentation folder. Defaults to `docs`.
5050
- `cache_dir` - The path which holds the authors cache file to speed up documentation builds. Defaults to `.cache/plugin/git-committers/`. The cache file is named `page-authors.json.json`.
51-
- `exclude` - Specify a list of page source paths (one per line) that should not have author(s) or last commit date included (excluded from processing by this plugin). Default is empty. [Example Usage](https://timvink.github.io/mkdocs-git-authors-plugin/options.html#exclude).
51+
- `exclude` - Specify a list of page source paths (one per line) that should not have author(s) or last commit date included (excluded from processing by this plugin). Default is empty. Examples:
52+
53+
```
54+
# mkdocs.yml
55+
plugins:
56+
- git-committers:
57+
exclude:
58+
- README.md
59+
- subfolder/page.md
60+
- another_page.md
61+
- all_files_inside_folder/*
62+
- folder_and_subfolders/**
63+
```
5264

5365
## History
5466

0 commit comments

Comments
 (0)