Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
MkDocs plugin to add a last updated date to your site pages
https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
git mkdocs mkdocs-material mkdocs-plugin timeago
Last synced: 2 days ago
JSON representation
MkDocs plugin to add a last updated date to your site pages
- Host: GitHub
- URL: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
- Owner: timvink
- License: mit
- Created: 2019-11-26T12:11:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T12:57:38.000Z (24 days ago)
- Last Synced: 2025-01-02T13:34:01.748Z (23 days ago)
- Topics: git, mkdocs, mkdocs-material, mkdocs-plugin, timeago
- Language: Python
- Homepage: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html
- Size: 2.53 MB
- Stars: 213
- Watchers: 4
- Forks: 45
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - timvink/mkdocs-git-revision-date-localized-plugin - MkDocs plugin to add a last updated date to your site pages (Python)
README
[](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` (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](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.