[](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/actions)
# mkdocs-git-revision-date-localized-plugin
[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. Initial fork from [mkdocs-git-revision-date-plugin](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin).
(*Example when used together with the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme*)
Other MkDocs plugins that use information from git:
- [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin) for displaying the authors from git
- [mkdocs-git-committers-plugin](https://github.com/byrnereese/mkdocs-git-committers-plugin) for displaying authors' github user profiles
## Setup
Install the plugin using `pip3` with the following command:
```bash
pip3 install mkdocs-git-revision-date-localized-plugin
```
Next, add the following lines to your `mkdocs.yml`:
```yaml
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](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/).
See 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.
### Note when using build environments
This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:
<details>
<summary>Change your CI settings</summary>
<ul>
<li>github actions: set <code>fetch-depth</code> to <code>0</code> (<a href="https://github.com/actions/checkout">docs</a>)</li>
<li>gitlab runners: set <code>GIT_DEPTH</code> to <code>0</code> (<a href="https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone">docs</a>)</li>
<li>bitbucket pipelines: set <code>clone: depth: full</code> (<a href="https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/">docs</a>)</li>
</ul>
</details>
## Documentation
See [timvink.github.io/mkdocs-git-revision-date-localized-plugin](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html).
## Contributing
Contributions 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/timvink/mkdocs-git-revision-date-localized-plugin",
"name": "mkdocs-git-revision-date-localized-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs git date timeago babel plugin",
"author": "Tim Vink",
"author_email": "vinktim@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/05/9ce3778a3452f1cd8ef6159d4fb290118751da74e46199357dd2ff56b071/mkdocs_git_revision_date_localized_plugin-1.2.5.tar.gz",
"platform": null,
"description": "[](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/actions)\n\n\n\n\n\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. Initial fork from [mkdocs-git-revision-date-plugin](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin).\n\n\n\n(*Example when used together with the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme*)\n\nOther MkDocs plugins that use information from git:\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](https://github.com/byrnereese/mkdocs-git-committers-plugin) for displaying authors' github user profiles\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 environments\n\nThis plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:\n\n<details>\n <summary>Change your CI settings</summary>\n <ul>\n <li>github actions: set <code>fetch-depth</code> to <code>0</code> (<a href=\"https://github.com/actions/checkout\">docs</a>)</li>\n <li>gitlab runners: set <code>GIT_DEPTH</code> to <code>0</code> (<a href=\"https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone\">docs</a>)</li>\n <li>bitbucket pipelines: set <code>clone: depth: full</code> (<a href=\"https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/\">docs</a>)</li>\n </ul>\n</details>\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.",
"version": "1.2.5",
"project_urls": {
"Homepage": "https://github.com/timvink/mkdocs-git-revision-date-localized-plugin"
},
"split_keywords": [
"mkdocs",
"git",
"date",
"timeago",
"babel",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe59d3306639a9957f8e62e789a5a0e0be36da132522a88bcabafad52b2acfcf",
"md5": "04f54d43a3e1c700557efd2e1ea72af2",
"sha256": "d796a18b07cfcdb154c133e3ec099d2bb5f38389e4fd54d3eb516a8a736815b8"
},
"downloads": -1,
"filename": "mkdocs_git_revision_date_localized_plugin-1.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04f54d43a3e1c700557efd2e1ea72af2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21975,
"upload_time": "2024-04-30T21:22:08",
"upload_time_iso_8601": "2024-04-30T21:22:08.949878Z",
"url": "https://files.pythonhosted.org/packages/fe/59/d3306639a9957f8e62e789a5a0e0be36da132522a88bcabafad52b2acfcf/mkdocs_git_revision_date_localized_plugin-1.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4059ce3778a3452f1cd8ef6159d4fb290118751da74e46199357dd2ff56b071",
"md5": "cdaca407457b7712171d4e36c3ac4c0c",
"sha256": "0c439816d9d0dba48e027d9d074b2b9f1d7cd179f74ba46b51e4da7bb3dc4b9b"
},
"downloads": -1,
"filename": "mkdocs_git_revision_date_localized_plugin-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "cdaca407457b7712171d4e36c3ac4c0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27083,
"upload_time": "2024-04-30T21:22:10",
"upload_time_iso_8601": "2024-04-30T21:22:10.983527Z",
"url": "https://files.pythonhosted.org/packages/c4/05/9ce3778a3452f1cd8ef6159d4fb290118751da74e46199357dd2ff56b071/mkdocs_git_revision_date_localized_plugin-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 21:22:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timvink",
"github_project": "mkdocs-git-revision-date-localized-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "GitPython",
"specs": []
},
{
"name": "babel",
"specs": [
[
">=",
"2.7.0"
]
]
},
{
"name": "pytz",
"specs": []
}
],
"lcname": "mkdocs-git-revision-date-localized-plugin"
}
JSON
