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 1000 (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.9.2.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_git_authors_plugin-0.9.2.tar.gz
Algorithm Hash digest
SHA256 77f97c321e08a8757beb866293eb257070b11cd5a080976bc6696b249cbade4f
MD5 a2285fe1a4df8db116170284e62f75ab
BLAKE2b-256 80ef09ab7178d580e342cb3ba279c48eaf3abf55795a2ae6e5426fe2c725143c

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

File hashes

Hashes for mkdocs_git_authors_plugin-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6cefc4dc832865d26f7f9f944c0a8c7dc852742d79320f3800e0d97814e2a84
MD5 0af9157c087578ff36525b98f0665e42
BLAKE2b-256 480857d0fea1cc30096fcc94ec9cd4ccdee625be89fd710626f78d90fc13738e

See more details on using hashes here.

Provenance

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

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

Attestations:

Supported by

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