{"id":5999,"library":"mkdocs-git-authors-plugin","title":"Mkdocs Git Authors Plugin","description":"mkdocs-git-authors-plugin is a lightweight MkDocs plugin designed to display git authors of a markdown page directly within your generated documentation. It is currently at version 0.10.0 and maintains an active development cycle with frequent releases.","status":"active","version":"0.10.0","language":"en","source_language":"en","source_url":"https://github.com/timvink/mkdocs-git-authors-plugin","tags":["mkdocs","plugin","git","authors","documentation"],"install":[{"cmd":"pip install mkdocs-git-authors-plugin","lang":"bash","label":"Install with pip"}],"dependencies":[{"reason":"Required for MkDocs plugin functionality.","package":"mkdocs","optional":false},{"reason":"Requires the underlying Git command-line tool to analyze repository history.","package":"git","optional":false}],"imports":[{"note":"MkDocs plugins are configured in mkdocs.yml and automatically loaded by the MkDocs build system.","symbol":"GitAuthorsPlugin","correct":"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'."}],"quickstart":{"code":"plugins:\n  - search\n  - git-authors:\n      show_contribution: true\n      show_email_address: true\n\n# To display authors in your markdown pages (e.g., at the end of a page):\n# Add {{ git_page_authors }} to your .md file or theme template.","lang":"yaml","description":"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."},"warnings":[{"fix":"Upgrade your Python environment to 3.8 or higher.","message":"Python 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.","severity":"breaking","affected_versions":">=0.8.0"},{"fix":"Adjust your CI/CD configuration for Git clone depth. Refer to the plugin's documentation for specific examples for different platforms.","message":"For 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.","severity":"gotcha","affected_versions":"All versions"},{"fix":"Add `add_co_authors: true` under the `git-authors` plugin configuration in `mkdocs.yml`.","message":"The `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`.","severity":"gotcha","affected_versions":">=0.10.0"},{"fix":"Upgrade `mkdocs-material` to version 9.5.0 or higher, or follow the plugin's documentation for theme customization with template overrides.","message":"When 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.","severity":"gotcha","affected_versions":"<9.5.0 of mkdocs-material"},{"fix":"Upgrade to the latest version of `mkdocs-git-authors-plugin` (0.9.4 or higher) to resolve these issues.","message":"Previous 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.","severity":"gotcha","affected_versions":"<0.9.4"}],"env_vars":null,"last_verified":"2026-04-14T00:00:00.000Z","next_check":"2026-07-13T00:00:00.000Z"}