PyPI - Python Version PyPI PyPI - Downloads GitHub contributors PyPI - License

mkdocs-git-authors-plugin

Lightweight MkDocs plugin to display git authors of a markdown page:

Authors: Jane Doe, John Doe

See the demo. The plugin only considers authors of the current lines in the page ('surviving code' using git blame).

Other MkDocs plugins that use information from git:

mkdocs-git-revision-date-localized-plugin for displaying the last revision date
mkdocs-git-committers-plugin for displaying authors' github user profiles

Setup

Install the plugin using pip3:

pip3 install mkdocs-git-authors-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - git-authors

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

You can then use the {{ git_page_authors }} tag in your markdown document, or choose to customize your mkdocs theme (see usage page in the docs).

Note when using build environments

This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:

Change your CI settings

github actions: set fetch_depth to 0 (docs)
gitlab runners: set GIT_DEPTH to 0 (docs)
bitbucket pipelines: set clone: depth: full (docs)

Documentation

See timvink.github.io/mkdocs-git-authors-plugin

Contributing

Very much open to contributions! Please read contributing guide before putting in any work.

Release files for mkdocs-git-authors-plugin 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-git-authors-plugin 0.10.0
File	Size	Uploaded
mkdocs_git_authors_plugin-0.10.0.tar.gz	23.4 kB	Jun 10, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-git-authors-plugin 0.10.0
File	Interpreter	ABI	Platform	Reset
mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl 21.9 kB Jun 10, 2025	Python 3	none	any	Details

Total release size: 45.3 kB

Release files / mkdocs_git_authors_plugin-0.10.0.tar.gz

Download URL	mkdocs_git_authors_plugin-0.10.0.tar.gz
Size	23.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`29d1973b2835663d79986fb756e02f1f0ff3fe35c278e993206bd3c550c205e4`
BLAKE2b-256 checksum How to use checksums	`64f1b784c631b812aab80030db80127a576b68a84caac5229836fb7fcc00e055`
Upload date	Jun 10, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/timvink/mkdocs-git-authors-plugin
Publishing commit: github.com/timvink/mkdocs-git-authors-plugin/tree/d0fbbda7f52769254cc88b3e3ac8b9254469712f

Workflow

Publishing configuration: github.com/timvink/mkdocs-git-authors-plugin/blob/d0fbbda7f52769254cc88b3e3ac8b9254469712f/.github/workflows/pythonpublish.yml
Publishing logs: github.com/timvink/mkdocs-git-authors-plugin/actions/runs/15551527452/attempts/1

Artifact

Subject: mkdocs_git_authors_plugin-0.10.0.tar.gz
SHA-256 checksum: 29d1973b2835663d79986fb756e02f1f0ff3fe35c278e993206bd3c550c205e4 Verifying attestations

Release files / mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl

Download URL	mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl
Size	21.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`28421a99c3e872a8e205674bb80ec48524838243e5f59eaf9bd97df103e38901`
BLAKE2b-256 checksum How to use checksums	`41bca4166201c2789657c4d370bfcd71a5107edec185ae245675c8b9a6719243`
Upload date	Jun 10, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/timvink/mkdocs-git-authors-plugin
Publishing commit: github.com/timvink/mkdocs-git-authors-plugin/tree/d0fbbda7f52769254cc88b3e3ac8b9254469712f

Workflow

Publishing configuration: github.com/timvink/mkdocs-git-authors-plugin/blob/d0fbbda7f52769254cc88b3e3ac8b9254469712f/.github/workflows/pythonpublish.yml
Publishing logs: github.com/timvink/mkdocs-git-authors-plugin/actions/runs/15551527452/attempts/1

Artifact

Subject: mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl
SHA-256 checksum: 28421a99c3e872a8e205674bb80ec48524838243e5f59eaf9bd97df103e38901 Verifying attestations