Mkdocs plugin to display git timeline of a page
Project description
mkdocs-git-timeline-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-timeline-plugin
Next, add the following lines to your mkdocs.yml
:
plugins:
- search
- git-timeline
If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
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
Documentation
See timvink.github.io/mkdocs-git-timeline-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 Distributions
Built Distribution
Hashes for mkdocs_git_timeline_plugin-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ada48cb2642b44cff01472e8d039424879c2d025a897494c997fb2aed1e0fa0 |
|
MD5 | 1fa78bc89edfea12dbca5c3677375fe3 |
|
BLAKE2b-256 | 7789103b5c8eb0d8bfcf058fffd4afb4572d36d7de7831e3e3eaa405712eae38 |