You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Other MkDocs plugins that use information to fetch authors:
9
14
10
15
-[`mkdocs-git-authors-plugin`](https://github.com/timvink/mkdocs-git-authors-plugin) for displaying user names a number of lines contributed (uses local Git information)
11
16
-[`mkdocs-git-committers-plugin`](https://github.com/byrnereese/mkdocs-git-committers-plugin) display contributors for a page (uses local Git information, completed with REST GitHub API v3)
12
17
13
-
## History
14
-
15
-
This is a fork from the original [`mkdocs-git-committers-plugin`](https://github.com/byrnereese/mkdocs-git-committers-plugin) by @byrnereese.
16
-
17
-
I had to create this fork so that it could be uploaded and distributed through PyPi. The package has been renamed to `mkdocs-git-committers-plugin-2`.
18
-
19
-
This "v2" differs from the original by:
20
-
21
-
- Fetch contributors directly from GitHub
22
-
- Eliminate the need to match git commit logs with entries in GitHub, and thus GitHub API calls
23
-
- No more risk of matching the incorrect contributor as the information comes directly from GitHub
24
-
- last_commit_date is now populated with local git info
25
-
- Use a cache file to speed up following builds: authors are fetched from GitHub for a page only if that page has changed since the last build
26
-
27
-
All of the above improves accuracy and performances.
28
-
29
-
Note: the plugin configuration in `mkdocs.yml` still uses the original `git-committers` sections.
30
-
31
-
## material for mkdocs theme
32
-
33
-
This plugin is integrated in the [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) theme by [Martin Donath](https://github.com/squidfunk).
34
-
35
-
## Limitations
36
-
37
-
- Getting the contributors relies on what is available on GitHub. This means that for new files, the build will report no contributors (and informed you with a 404 error which can be ignored)
38
-
When the file is merged, the contributors will be added normally.
39
-
- For now, Git submodule is not supported and will report no contributors.
40
-
41
18
## Setup
42
19
43
20
Install the plugin using pip:
@@ -73,8 +50,38 @@ More information about plugins in the [MkDocs documentation][mkdocs-plugins].
73
50
- `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`.
74
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).
75
52
53
+
## History
54
+
55
+
This is a fork from the original [`mkdocs-git-committers-plugin`](https://github.com/byrnereese/mkdocs-git-committers-plugin) by @byrnereese.
56
+
57
+
I had to create this fork so that it could be uploaded and distributed through PyPi. The package has been renamed to `mkdocs-git-committers-plugin-2`.
58
+
59
+
This "v2" differs from the original by:
60
+
61
+
- Fetch contributors directly from GitHub
62
+
- Eliminate the need to match git commit logs with entries in GitHub, and thus GitHub API calls
63
+
- No more risk of matching the incorrect contributor as the information comes directly from GitHub
64
+
- last_commit_date is now populated with local git info
65
+
- Use a cache file to speed up following builds: authors are fetched from GitHub for a page only if that page has changed since the last build
66
+
67
+
All of the above improves accuracy and performances.
68
+
69
+
Note: the plugin configuration in `mkdocs.yml` still uses the original `git-committers` sections.
70
+
71
+
## Limitations
72
+
73
+
- Getting the contributors relies on what is available on GitHub. This means that for new files, the build will report no contributors (and informed you with a 404 error which can be ignored)
74
+
When the file is merged, the contributors will be added normally.
75
+
- For now, Git submodule is not supported and will report no contributors.
76
+
76
77
## Usage
77
78
79
+
You have 2 options to use this plugin:
80
+
81
+
1. Use Mkdocs material theme (see [Mkdocs material
0 commit comments