Skip to content

Commit 6d0fd64

Browse files
committed
Add documentation for cache_dir config
1 parent 2d34cc2 commit 6d0fd64

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ More information about plugins in the [MkDocs documentation][mkdocs-plugins].
5050
- `branch` - The name of the branch to get contributors from. Example: 'master' (default)
5151
- `enterprise_hostname` - For GitHub enterprise: the enterprise hostname.
5252
- `docs_path` - the path to the documentation folder. Defaults to `docs`.
53+
- `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`.
5354

5455
If the token is not set in `mkdocs.yml` it will be read from the `MKDOCS_GIT_COMMITTERS_APIKEY` environment variable.
5556

0 commit comments

Comments
 (0)