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
with the following command:
pip install mkdocs-git-revision-date-localized-plugin
Next, add the following lines to your mkdocs.yml
:
plugins:
- search
- git-revision-date-localized
If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set.
When using CI runners
The plugin needs access to the last commit that touched a file to be able to retrieve the date. If you build your docs using CI then you might need to change the default settings:
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
To change the date format, set the type
parameter 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
)
fallback_to_build_date
If set to true
(default is false
) the plugin will use the time when running mkdocs build
instead of the git revision date. This means the revision date will be inaccurate, but this can be useful if your build environment has no access to GIT and you want to ignore the Git exceptions during git log
.
Example
Example with all options:
# mkdocs.yml
plugins:
- git-revision-date-localized:
locale: en
type: timeago
fallback_to_build_date: true
Result:
20 hours ago
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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dfbd33d9a0e4aa2250557a957d19fe42b958e023688fbf4015c6d2b0ba99124 |
|
MD5 | 7f57a7b633313fa8e8c3edbd93624419 |
|
BLAKE2b-256 | 5a0a4519dc23b5d91242fb37a067bf943ac986611d87853caa5ec83ffeb98582 |
Hashes for mkdocs_git_revision_date_localized_plugin-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecf2e8cc6870c8fdceaa82528955c35a5323cb5174911f74310a60031919e2a5 |
|
MD5 | 5baa7b4fa4acc1a3a10a6b511a7a80fd |
|
BLAKE2b-256 | 1af619f99f619bbafd0d311dec1501203badfd7d5e09290b36f83c6f29ab00c8 |