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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a603a6d1c628a0ff50734ec511fcda899dcf13469e38797dd7d40329461a334 |
|
MD5 | 9b904a7dff542a5c4843896beb9f50b8 |
|
BLAKE2b-256 | 2fcb29ac17ab22a087760c72b96e5f904f8a357f7313a45f857003af31aac57a |
Hashes for mkdocs_git_revision_date_localized_plugin-0.4.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 746aaeae8eb520067bb0542bb69cf377de1e33a48374dd761d7002287fcdd135 |
|
MD5 | 61291bea5b42089faa319611612ca2fb |
|
BLAKE2b-256 | 79db4ddc81b2637558cc3ed2348c92c36e8e8a6ad654b9a191fab943cc5b2427 |