Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.
Project description
mkdocs-git-revision-date-localized-plugin
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
Setup
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.
The mkdocs-material theme has built in support for git-revision-date-localized
and you should already see the last revision date on the bottom of your pages. See the documentation on how to fine-tune the appearance and the date format.
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-revision-date-localized-plugin.
Contributing
Contributions are very welcome! Please read CONTRIBUTING.md before putting in any work.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-git-revision-date-localized-plugin-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38517e2084229da1a1b9460e846c2748d238c2d79efd405d1b9174a87bd81d79 |
|
MD5 | ef3f1150df497ba409e6396092d92f74 |
|
BLAKE2b-256 | 30443d732ad3cb6e7875e216e0ef496939643ca46fb007806ac44e10b1b9cddb |
Hashes for mkdocs_git_revision_date_localized_plugin-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ba0e49abea3e9f6ee26e2623ff7283873da657471c61f1d0cfbb986f403316d |
|
MD5 | e536ec8457bd6f087afeae5bdce9e2ee |
|
BLAKE2b-256 | 9663ea5d529d8a25fe68f56c199cbdc5408ff6ab5cd8b8f31f2f13f63c02e2ef |