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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cc9470b992a8541ae38db761e6f1ad7e2021b09a1e755fc2debe91b7a3c1194 |
|
MD5 | fe6d0f17dee2c3023968cbf92bcb2143 |
|
BLAKE2b-256 | bab3ae6bcf314d491265c8eeb5c1199e48569f75b6aa53849d929a5f67a5c07b |
Hashes for mkdocs_git_revision_date_localized_plugin-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 398973304d428bdec34c8c3e82bb30a5cc2ece80afc468bbd29ed6f95145dc1c |
|
MD5 | e178a162c79ffed0aa189c8bb86a7840 |
|
BLAKE2b-256 | bf7d5f648675d5773199a3b90ca976d2786e9d797c02a74413ede74464e05e5e |