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 localized date of the last git modification of a markdown file. Forked from mkdocs-git-revision-date-plugin. The plugin uses babel and timeago to provide different localized date formats.
(Example when used together with mkdocs-material theme)
Setup
Install the plugin using pip:
pip install mkdocs-git-revision-date-localized-plugin
Activate the plugin in mkdocs.yml
:
plugins:
- git-revision-date-localized
Usage
In supported themes
- mkdocs-material offers support for this plugin, see setup instructions
In theme templates
In templates you can use page.meta.git_revision_date_localized
:
{% if page.meta.git_revision_date_localized %}
Last update: {{ page.meta.git_revision_date_localized }}
{% endif %}
In markdown pages
In your markdown files you can use {{ git_revision_date_localized }}
:
Last update: {{ git_revision_date_localized }}
Options
type
Set this option to one of date
, datetime
, iso_date
, iso_datetime
or timeago
. Default is date
. Example outputs:
28 November, 2019 # type: date
28 November, 2019 13:57:28 # type: datetime
2019-11-28 # type: iso_date
2019-11-28 13:57:26 # type: iso_datetime
20 hours ago # type: timeago
locale
Set this option to a two letter ISO639 language code to use a another language. This will overwrite any locale setting in mkdocs
or your theme. If no locale is set fallback is English (en
).
Example
Example of setting both options:
# mkdocs.yml
plugins:
- git-revision-date-localized:
type: timeago
locale: nl
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-0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06df2142623aa4ca9997e94a75ef71eabae345ab9ffc9164537ffb06bdc0456e |
|
MD5 | a6984c715ff428759ae8b3ce0cb70fc2 |
|
BLAKE2b-256 | bf30346dea9f6734c726860f3441559282e5accf84ad6df02c0ce8837c8ff7d3 |
Hashes for mkdocs_git_revision_date_localized_plugin-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d65e96a06493946a387b1c4743235cd01a901e3b827ff45b8f639f10342db552 |
|
MD5 | 84a8514ffbaea2c57c37394f56fb3cd4 |
|
BLAKE2b-256 | 016672045f634fd9b663031b935985baf110420e7422d42184002f036bb4e81d |