Skip to main content

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

Project description

PyPI - Python Version PyPI PyPI - Downloads

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

(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

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 or type: 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 or language 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


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.4.5
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_git_revision_date_localized_plugin-0.4.5-py3-none-any.whl (5.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mkdocs-git-revision-date-localized-plugin-0.4.5.tar.gz (74.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page