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 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
Specify a two letter ISO639 language code to display dates in your preferred language.
- When used in combination with
type: date
ortype: datetime
, translation is done using babel which supports these locales - When used in combination with
type: timeago
then timeago.js is added to your website, which supports these locales. If you specify a locale not supported by timeago.js, the fallback is English (en
) - When not set, this plugin will look for
locale
orlanguage
options set in your theme. If also not set, the 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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cf27067ba2c7b8b6182de65d57724534cba4849309c0516471db659083c9696 |
|
MD5 | d6a7f6e698ca8968841156318d9cfc5a |
|
BLAKE2b-256 | a91f27051eae03b240db3ddf463370fb75d88923d5bf885ae96ae8c2da3e431d |
Hashes for mkdocs_git_revision_date_localized_plugin-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dec02f4ac6633306e45e630cecfc6ce7f93c6d13054247a3029e5f94026b4469 |
|
MD5 | af9ae71e544d589e1a07e3d788b0d34b |
|
BLAKE2b-256 | 21327ed5ea02e7bc2e18cdeb7a31d8f3735ebf78f047a73dbd81ec393dfbac89 |