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.