| Name | mkdocs-git-revision-date-localized-plugin JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file. |
| upload_time | 2024-10-22 12:45:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
mkdocs
plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](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 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` (<a href="https://github.com/actions/checkout">docs</a>)</li>
- Gitlab Runners: set `GIT_DEPTH` to `0` (<a href="https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone">docs</a>)</li>
- Bitbucket pipelines: set `clone: depth: full` (<a href="https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/">docs</a>)</li>
- 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))
## 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": null,
"name": "mkdocs-git-revision-date-localized-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs, plugin",
"author": null,
"author_email": "Tim Vink <vinktim@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/73/85/6dc9d4eca486ed5734a05f7fd5c612a8e60a35e65610dad6aa9c58118c3f/mkdocs_git_revision_date_localized_plugin-1.3.0.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 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` (<a href=\"https://github.com/actions/checkout\">docs</a>)</li>\n- Gitlab Runners: set `GIT_DEPTH` to `0` (<a href=\"https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone\">docs</a>)</li>\n- Bitbucket pipelines: set `clone: depth: full` (<a href=\"https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/\">docs</a>)</li>\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## 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.3.0",
"project_urls": {
"Homepage": "https://github.com/timvink/mkdocs-git-revision-date-localized-plugin"
},
"split_keywords": [
"mkdocs",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "67e5ffeb92db53af8c3aa2d92e21a3cf6b5f83eee7e03b9cf9234ef6b30230d5",
"md5": "5a4d20123d1e9500d097b45974b6828e",
"sha256": "c99377ee119372d57a9e47cff4e68f04cce634a74831c06bc89b33e456e840a1"
},
"downloads": -1,
"filename": "mkdocs_git_revision_date_localized_plugin-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a4d20123d1e9500d097b45974b6828e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22549,
"upload_time": "2024-10-22T12:45:11",
"upload_time_iso_8601": "2024-10-22T12:45:11.339005Z",
"url": "https://files.pythonhosted.org/packages/67/e5/ffeb92db53af8c3aa2d92e21a3cf6b5f83eee7e03b9cf9234ef6b30230d5/mkdocs_git_revision_date_localized_plugin-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73856dc9d4eca486ed5734a05f7fd5c612a8e60a35e65610dad6aa9c58118c3f",
"md5": "f0e725b4d281a36d51ddfb71be2d0429",
"sha256": "439e2f14582204050a664c258861c325064d97cdc848c541e48bb034a6c4d0cb"
},
"downloads": -1,
"filename": "mkdocs_git_revision_date_localized_plugin-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "f0e725b4d281a36d51ddfb71be2d0429",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 384797,
"upload_time": "2024-10-22T12:45:13",
"upload_time_iso_8601": "2024-10-22T12:45:13.114582Z",
"url": "https://files.pythonhosted.org/packages/73/85/6dc9d4eca486ed5734a05f7fd5c612a8e60a35e65610dad6aa9c58118c3f/mkdocs_git_revision_date_localized_plugin-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 12:45:13",
"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": [],
"lcname": "mkdocs-git-revision-date-localized-plugin"
}
