MkDocs Git Revision Date Localized Plugin

1.5.1 · active · verified Sat Apr 11

This MkDocs plugin enables displaying the localized date of the last Git modification (and creation) of a Markdown file directly in your documentation. It is currently at version 1.5.1 and maintains an active release cadence with regular minor and patch updates.

Warnings

breaking Python 3.8 and 3.9 are no longer supported as of version 1.5.0. Users on these Python versions should upgrade to Python 3.10 or newer, or pin the plugin version to <1.5.0.
Fix: Upgrade your Python environment to 3.10 or later, or specify `mkdocs-git-revision-date-localized-plugin<1.5.0` in your dependencies.
breaking As of version 1.3.0, the plugin changed how it calculates revision dates by ignoring whitespace-only and blank line changes, as well as rename commits. This may lead to different (and often more accurate) revision dates than in previous versions.
Fix: Be aware that revision dates displayed in your documentation might change after upgrading to v1.3.0 or later. No code changes are required, but verify the output.
gotcha The plugin relies heavily on the `git` command-line tool. Ensure `git` is installed and accessible in your system's PATH, especially when building documentation in Docker containers (e.g., Alpine Linux may require explicit Git installation).
Fix: Verify `git` is installed and available. For Docker, include `apk add git` or similar in your Dockerfile if not present.
gotcha Users working with monorepos might encounter issues with revision date accuracy due to the plugin's reliance on Git operations relative to the repository root. While multiple fixes have been applied (e.g., in v1.4.1, v1.4.5, v1.5.0), complex monorepo setups can still be challenging.
Fix: Ensure your `mkdocs.yml` is correctly placed and Git repository structure is standard. If issues persist, consult the plugin's GitHub issues for monorepo-specific discussions and configurations.

Install

pip install mkdocs-git-revision-date-localized-plugin Install plugin

Imports

Plugin
```
This plugin is configured in mkdocs.yml, not imported directly in Python code.
```
MkDocs plugins are automatically loaded and initialized by MkDocs based on your configuration in `mkdocs.yml` under the `plugins` section.

Quickstart

To use the plugin, add it to the `plugins` section of your `mkdocs.yml` file. You can then reference `{{ git_revision_date_localized }}` and `{{ git_creation_date_localized }}` variables in your Markdown files.

# mkdocs.yml
site_name: My Awesome Docs

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
      locale: en
      timezone: Europe/Berlin

# --- Create docs/index.md for testing ---
# In your project root, create a 'docs' directory:
# mkdir -p docs
# echo '# Welcome\n\nLast updated: {{ git_revision_date_localized }}\nCreated: {{ git_creation_date_localized }}' > docs/index.md

# --- Build and serve --- 
# mkdocs build
# mkdocs serve

view raw JSON →