MkDocs plugin that enables displaying the date of the last git modification of a page. The plugin uses babel and timeago.js to provide different localized date formats. Initial fork from mkdocs-git-revision-date-plugin.
(Example when used together with the mkdocs-material theme)
Other MkDocs plugins that use information from git:
- mkdocs-git-authors-plugin for displaying the authors from git
- mkdocs-git-committers-plugin for displaying authors' github user profiles
Install the plugin using pip3
with the following command:
pip3 install mkdocs-git-revision-date-localized-plugin
Next, add the following lines to your mkdocs.yml
:
plugins:
- search
- git-revision-date-localized
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.
If you use the mkdocs-material theme, you should already see the last revision on the bottom of your pages.
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
See timvink.github.io/mkdocs-git-revision-date-localized-plugin.
Contributions are very welcome! Please read CONTRIBUTING.md before putting in any work.