Skip to main content

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

(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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-git-revision-date-localized-plugin, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_git_revision_date_localized_plugin-0.2.1-py3-none-any.whl (4.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-git-revision-date-localized-plugin-0.2.1.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page