Registry /
devops / mkdocs-git-authors-plugin
Install & Compatibility
Where this runs
tested against v0.10.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 33.1MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 3.0s · import 0.000s · 34MB
32MB installed
● package 32MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
GitAuthorsPlugin
✓ This plugin is enabled via mkdocs.yml configuration; no direct Python imports are typically used in user code. The internal entry point is 'mkdocs_git_authors_plugin.plugin:GitAuthorsPlugin'.
MkDocs plugins are configured in mkdocs.yml and automatically loaded by the MkDocs build system.
To enable the plugin, add `git-authors` to the `plugins` section in your `mkdocs.yml` file. You can then use Jinja tags like `{{ git_page_authors }}` directly within your Markdown files or theme templates to display author information.
plugins:
- search
- git-authors:
show_contribution: true
show_email_address: true
# To display authors in your markdown pages (e.g., at the end of a page):
# Add {{ git_page_authors }} to your .md file or theme template.
Debug
Known issues
breakingPython 3.7 support was dropped in version 0.8.0. Users on Python 3.7 or older must upgrade to Python 3.8+ to use this version and newer releases.fixUpgrade your Python environment to 3.8 or higher.
affects: >=0.8.0
gotchaFor CI/CD environments (e.g., GitHub Actions, GitLab CI, Bitbucket Pipelines), you must configure your git clone/fetch depth to retrieve the full repository history (e.g., `fetch_depth: 0`, `GIT_DEPTH: 0`, `clone: depth: full`). The plugin needs the entire history to accurately determine authors.fixAdjust your CI/CD configuration for Git clone depth. Refer to the plugin's documentation for specific examples for different platforms.
affects: All versions
gotchaThe `add_co_authors` option, introduced in v0.10.0, is disabled by default. If you wish to display git co-authors in addition to the primary commit author, you must explicitly set `add_co_authors: true` in your `mkdocs.yml`.fixAdd `add_co_authors: true` under the `git-authors` plugin configuration in `mkdocs.yml`.
affects: >=0.10.0
gotchaWhen using `mkdocs-material` theme versions older than 9.5.0, deep integration requires manual template overrides to properly display and style the author information. Newer versions (>=9.5.0) have built-in support.fixUpgrade `mkdocs-material` to version 9.5.0 or higher, or follow the plugin's documentation for theme customization with template overrides.
affects: <9.5.0 of mkdocs-material
gotchaPrevious versions (e.g., prior to v0.9.1, v0.9.3, v0.9.4) had known issues processing generated files or files located outside the `docs_dir`, potentially leading to errors or missing author information. Ensure you are on a recent version to benefit from these fixes.fixUpgrade to the latest version of `mkdocs-git-authors-plugin` (0.9.4 or higher) to resolve these issues.
affects: <0.9.4
Upgrade
Version history
0.10.0latest on PyPI · released Jun 10, 2025
Audit
Dependencies
mkdocsrequiredRequired for MkDocs plugin functionality.
gitrequiredRequires the underlying Git command-line tool to analyze repository history.