Skip to main content

Actions Status PyPI - Python Version PyPI PyPI - Downloads GitHub contributors PyPI - License

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. Works with mkdocs-material, see adding a git repository.

demo

(Example when used together with the mkdocs-material theme)

Setup

Install the plugin using pip3 with the following command:

pip3 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 the search plugin. MkDocs enables it by default if there is no plugins entry set.

The mkdocs-material theme supports git-revision-date-localized. After installing the plugin and updating your mkdocs.yml you should see the last revision date on the bottom of your pages. Other mkdocs themes require additional customization.

See the documentation on how to fine-tune the appearance and the date format.

Note when using build systems like Github Actions

This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many CI/CD build systems only retrieve the last commit, which means you might need to change your CI/CD settings:

  • Github Actions: set fetch-depth to 0 (docs)
  • Gitlab Runners: set GIT_DEPTH to 0 (docs)
  • Bitbucket pipelines: set clone: depth: full (docs)
  • Azure Devops pipelines: set Agent.Source.Git.ShallowFetchDepth to something very high like 10e99 (docs)

Tip: You can speed up your builds for large codebases by running git garbage collection (git gc) occasionly. You can also use sparse checkouts to only apply the fetch-depth 0 for the folders we're interested (credits Martin in this tweet):

# example sparse checkout for github actions
- uses: actions/checkout@v4
  with:
    fetch-depth: 0
    sparse-checkout: |
      docs
      includes

Documentation

See timvink.github.io/mkdocs-git-revision-date-localized-plugin.

Contributing

Contributions are very welcome! Please read CONTRIBUTING.md before putting in any work.

Related MkDocs plugins:

Metadata

Release files for mkdocs-git-revision-date-localized-plugin 1.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-git-revision-date-localized-plugin 1.6.0
File Size Uploaded
mkdocs_git_revision_date_localized_plugin-1.6.0.tar.gz 37.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-git-revision-date-localized-plugin 1.6.0
File Interpreter ABI Platform
mkdocs_git_revision_date_localized_plugin-1.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 64.9 kB

Release files / mkdocs_git_revision_date_localized_plugin-1.6.0.tar.gz

Download URL mkdocs_git_revision_date_localized_plugin-1.6.0.tar.gz
Size 37.0 kB
Tags Source
SHA-256 checksum
How to use checksums
469af4b344a4d493a6402aa92eec87a6138e1dac444e9551c1af06991453954b
BLAKE2b-256 checksum
How to use checksums
f1a7ded2f0e2321213862225f9f657a51493af8f92626e3dd0a02ce9ef9b1131
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.

Transparency log

Release files / mkdocs_git_revision_date_localized_plugin-1.6.0-py3-none-any.whl

Download URL mkdocs_git_revision_date_localized_plugin-1.6.0-py3-none-any.whl
Size 28.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88b2d524d24c49a05cd6c9b1456f7dc0c8fa5e233b09ecf8a1dd12aebc127990
BLAKE2b-256 checksum
How to use checksums
5af7d4aeef9f48150900634e7f864b076038e69014fb3ae4e515035803bca561
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.6.0 This release

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.7

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.12

2 release files

0.11.1

2 release files

0.11

2 release files

0.10.3

2 release files

0.10.2

2 release files

0.10.0

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9

2 release files

0.8

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7

2 release files

0.6

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.8

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4

2 release files

0.3.3

2 release files

0.3.1

2 release files

0.2.1

2 release files

0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page