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 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
Setting a different configuration:
# 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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e411ca40a0b703888de8172d153bc91ca189b00f39c73b665fdb1cefee4e2ff6 |
|
MD5 | bdc7d7f07315f9fe6a734c764b6a6f5d |
|
BLAKE2b-256 | 57d276a49ba2662395d7e08a24e67cb0a066e80dc0664e2bc5f5e07238945896 |
Hashes for mkdocs_git_revision_date_localized_plugin-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fe35ec4756ebf182b3ac3ab90cc76a963e1d64aa1e3572dfc6e8f99b70b342c |
|
MD5 | e6ee166c8948c62cba36d14f8e200598 |
|
BLAKE2b-256 | 28bf798117664576ff80ad44008a34cdbda942c7096fde2bb4524876de14ba36 |