mkdocs-git-revision-date-localized-plugin 0.4.2

Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.

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 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

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

Example of setting both options:

# mkdocs.yml
plugins:
  - git-revision-date-localized:
    type: timeago
    locale: nl