{"id":13486984,"url":"https://github.com/timvink/mkdocs-git-revision-date-localized-plugin","last_synced_at":"2025-05-14T20:08:56.459Z","repository":{"id":41067147,"uuid":"224184174","full_name":"timvink/mkdocs-git-revision-date-localized-plugin","owner":"timvink","description":"MkDocs plugin to add a last updated date to your site pages","archived":false,"fork":false,"pushed_at":"2025-01-02T12:57:38.000Z","size":2652,"stargazers_count":213,"open_issues_count":12,"forks_count":45,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-02T13:34:01.748Z","etag":null,"topics":["git","mkdocs","mkdocs-material","mkdocs-plugin","timeago"],"latest_commit_sha":null,"homepage":"https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timvink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["timvink"]}},"created_at":"2019-11-26T12:11:05.000Z","updated_at":"2025-01-02T12:57:42.000Z","dependencies_parsed_at":"2023-01-29T18:00:28.018Z","dependency_job_id":"c5c0a169-7442-4860-917e-ac71a6841a5f","html_url":"https://github.com/timvink/mkdocs-git-revision-date-localized-plugin","commit_stats":{"total_commits":260,"total_committers":30,"mean_commits":8.666666666666666,"dds":0.3307692307692308,"last_synced_commit":"04db2bc607d698475e82ce2adef6022e05bafac3"},"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-revision-date-localized-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-revision-date-localized-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-revision-date-localized-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-revision-date-localized-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvink","download_url":"https://codeload.github.com/timvink/mkdocs-git-revision-date-localized-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248741196,"owners_count":21154252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","mkdocs","mkdocs-material","mkdocs-plugin","timeago"],"created_at":"2024-07-31T18:00:54.065Z","updated_at":"2025-04-13T15:59:02.801Z","avatar_url":"https://github.com/timvink.png","language":"Python","readme":"[![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\u003e 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` (\u003ca href=\"https://github.com/actions/checkout\"\u003edocs\u003c/a\u003e)\u003c/li\u003e\n- Gitlab Runners: set `GIT_DEPTH` to `0` (\u003ca href=\"https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone\"\u003edocs\u003c/a\u003e)\u003c/li\u003e\n- Bitbucket pipelines: set `clone: depth: full` (\u003ca href=\"https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/\"\u003edocs\u003c/a\u003e)\u003c/li\u003e\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).","funding_links":["https://github.com/sponsors/timvink"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-git-revision-date-localized-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvink%2Fmkdocs-git-revision-date-localized-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-git-revision-date-localized-plugin/lists"}