Skip to main content

Mkdocs plugin to display git authors of a page

Project description

Actions Status PyPI - Python Version PyPI PyPI - Downloads codecov 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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_git_authors_plugin-0.10.0.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_git_authors_plugin-0.10.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_git_authors_plugin-0.10.0.tar.gz
Algorithm Hash digest
SHA256 29d1973b2835663d79986fb756e02f1f0ff3fe35c278e993206bd3c550c205e4
MD5 57126957d2577e78c6dbec3efcfb5f12
BLAKE2b-256 64f1b784c631b812aab80030db80127a576b68a84caac5229836fb7fcc00e055

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_git_authors_plugin-0.10.0.tar.gz:

Publisher: pythonpublish.yml on timvink/mkdocs-git-authors-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 28421a99c3e872a8e205674bb80ec48524838243e5f59eaf9bd97df103e38901
MD5 882ef738ef1a9e07411a8d0fc849559e
BLAKE2b-256 41bca4166201c2789657c4d370bfcd71a5107edec185ae245675c8b9a6719243

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_git_authors_plugin-0.10.0-py3-none-any.whl:

Publisher: pythonpublish.yml on timvink/mkdocs-git-authors-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page