mkdocs-git-committers-plugin-2

What it is and what it does

This MkDocs plugin integrates contributor metadata into your documentation by querying GitHub or GitLab APIs to fetch the list of committers for each page. It displays contributor avatars and last-modified dates directly in your documentation, typically integrated into the Material for MkDocs theme but usable in custom templates as well.

The plugin works by fetching contributor data from GitHub or GitLab rather than parsing local git logs, which improves accuracy and eliminates the need to match commit authors manually. It caches results to speed up subsequent builds, only re-fetching when a page has changed. For GitHub, it counts commit authors, committers, and co-authors (with a token); for GitLab, it counts commit authors only. Configuration is minimal—just specify your repository and optionally provide an API token for private repos or to increase rate limits.

Use it for:

• Display contributor avatars and names on documentation pages to credit team members and encourage community contributions.
• Show the last-modified date on each page to help readers understand content freshness and recency.
• Integrate contributor metadata into Material for MkDocs theme without additional configuration.
• Track and display co-authors on documentation pages when using GitHub's co-author commit feature.
• Support both GitHub and GitLab repositories in the same documentation pipeline.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

MkDocs plugin that fetches and displays a list of contributors to each documentation page from GitHub or GitLab APIs, along with the last commit date.

Yes, if you use MkDocs and want to display contributor metadata on your documentation pages. The plugin has low install friction, no known vulnerabilities, and integrates well with Material for MkDocs. The aging maintenance status is not a blocker—the last commit was recent (June 2025) and the plugin is stable. Provide a GitHub or GitLab token to avoid rate limits and unlock full functionality like co-author detection.

Install

mkdocs-git-committers-plugin-2 on PyPI

pip install mkdocs-git-committers-plugin-2

uv add mkdocs-git-committers-plugin-2

poetry add mkdocs-git-committers-plugin-2

Installing mkdocs-git-committers-plugin-2

Before you install

Low friction install via pip. The package is in aging maintenance status with a last commit in June 2025, but remains actively used with 142000 monthly downloads and no known vulnerabilities.

License in practice

MIT license permits unrestricted use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install mkdocs-git-committers-plugin-2

# In mkdocs.yml:
plugins:
  - git-committers:
      repository: organization/repository

# Access in template:
{% for user in committers %}
  {{ user }}
{% endfor %}

Requires a GitHub or GitLab API token for GitLab repositories; GitHub token optional but recommended to avoid rate limits (60 requests per hour per IP without token).

Verify before relying

• Whether the plugin works with all MkDocs versions or has specific version constraints beyond Python 3.8+.
• Performance impact of API calls per page during large documentation builds.
• Whether GitLab user identification issues (issue #50) have been resolved since the last release.

Package facts

Evidence: mkdocs_git_committers_plugin_2-2.5.0-py3-none-any.whl

Keywords: mkdocs, plugin, github, committers

Tags

More Documentation packages