{"author":null,"author_email":"Tim Vink ","bugtrack_url":null,"classifiers":["License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"[![Actions Status](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/actions)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-git-revision-date-localized-plugin)\n![PyPI](https://img.shields.io/pypi/v/mkdocs-git-revision-date-localized-plugin)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-git-revision-date-localized-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-git-revision-date-localized-plugin)\n![PyPI - License](https://img.shields.io/pypi/l/mkdocs-git-revision-date-localized-plugin)\n\n# mkdocs-git-revision-date-localized-plugin\n\n[MkDocs](https://www.mkdocs.org/) plugin that enables displaying the date of the last git modification of a page. The plugin uses [babel](https://github.com/python-babel/babel/tree/master/babel) and [timeago.js](https://github.com/hustcc/timeago.js) to provide different localized date formats. Works with [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/), see [adding a git repository](https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/).\n\n![demo](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/raw/master/demo_screencast.gif)\n\n(*Example when used together with the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme*)\n\n## Setup\n\nInstall the plugin using `pip3` with the following command:\n\n```bash\npip3 install mkdocs-git-revision-date-localized-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - git-revision-date-localized\n```\n\n> 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.\n\nThe [mkdocs-material](https://squidfunk.github.io/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](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/howto/override-a-theme/).\n\nSee the [documentation](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html) on how to fine-tune the appearance and the date format.\n\n### **Note when using build systems like Github Actions**\n\nThis 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:\n\n- Github Actions: set `fetch-depth` to `0` (docs)\n- Gitlab Runners: set `GIT_DEPTH` to `0` (docs)\n- Bitbucket pipelines: set `clone: depth: full` (docs)\n- Azure Devops pipelines: set `Agent.Source.Git.ShallowFetchDepth` to something very high like `10e99` ([docs](https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/pipeline-options-for-git?view=azure-devops#shallow-fetch))\n\n*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](https://x.com/squidfunk/status/1705279829770150291)):\n\n```yaml\n# example sparse checkout for github actions\n- uses: actions/checkout@v4\n with:\n fetch-depth: 0\n sparse-checkout: |\n docs\n includes\n```\n\n## Documentation\n\nSee [timvink.github.io/mkdocs-git-revision-date-localized-plugin](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html).\n\n## Contributing\n\nContributions are very welcome! Please read [CONTRIBUTING.md](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/blob/master/CONTRIBUTING.md) before putting in any work.\n\n## Related MkDocs plugins:\n\n- [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin) for displaying the authors from git\n- [mkdocs-git-committers-plugin-2](https://github.com/ojacques/mkdocs-git-committers-plugin-2) for displaying authors' github user profiles\n- [mkdocs-document-dates](https://github.com/jaywhj/mkdocs-document-dates) for displaying dates based on file creation and modification dates.\n- Initial fork from [mkdocs-git-revision-date-plugin](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin).\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"mkdocs, plugin","license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"mkdocs-git-revision-date-localized-plugin","package_url":"https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/","platform":null,"project_url":"https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/","project_urls":{"Homepage":"https://github.com/timvink/mkdocs-git-revision-date-localized-plugin"},"provides_extra":null,"release_url":"https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/1.4.5/","requires_dist":["babel>=2.7.0","gitpython>=3.1.44","mkdocs>=1.0","pytz>=2025.1"],"requires_python":">=3.8","summary":"Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.","version":"1.4.5","yanked":false,"yanked_reason":null}

Dependencies of mkdocs-git-revision-date-localized-plugin (4).
Dependency	Optional
babel	false
gitpython	false
mkdocs	false
pytz	false

Package search

mkdocs-git-revision-date-localized-plugin

project_urls

Dependencies

All package metadata

Releases