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.
(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 }}
Localizated variants
The plugin uses babel and timeago to provide different date formats:
{{ git_revision_date_localized }}
{{ git_revision_date_localized_time }}
{{ git_revision_date_localized_iso }}
{{ git_revision_date_localized_iso_time }}
{{ git_revision_date_localized_timeago }}
Output:
28 November, 2019
28 November, 2019 13:57:28
2019-11-28
2019-11-28 13:57:26
20 hours ago
Options
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
).
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ac5833aae7ef53c3a9265ac7af019c8800c7b1c4021e36ff52f91e86e7bf7c7 |
|
MD5 | 2ff9e5faddf78e3ff70e5f73d1388993 |
|
BLAKE2b-256 | c57dcf09eb4777cea687243c2b06f913d9d4e826154971fe890327eb5c47399a |
Hashes for mkdocs_git_revision_date_localized_plugin-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4ce6f2cc9a17d797f552513bc552960e3d9050aadfa434ddfc601eae5d28f4f |
|
MD5 | 347ee9fa9b8c714ddb684bf601f5a4aa |
|
BLAKE2b-256 | 7359c3fa8dcebb66be1cc38b457d20ea1b8e91281c63a7e497eb4e39627aa9f4 |