Skip to main content

Actions Status PyPI - Python Version PyPI PyPI - Downloads GitHub contributors PyPI - License

mkdocs-git-revision-date-localized-plugin

MkDocs plugin that enables displaying the date of the last git modification of a page. The plugin uses babel and timeago.js to provide different localized date formats. Works with mkdocs-material, see adding a git repository.

demo

(Example when used together with the mkdocs-material theme)

Setup

Install the plugin using pip3 with the following command:

pip3 install mkdocs-git-revision-date-localized-plugin

Next, add the following lines to your mkdocs.yml:

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 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.

See the documentation 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)

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):

# example sparse checkout for github actions
- uses: actions/checkout@v4
  with:
    fetch-depth: 0
    sparse-checkout: |
      docs
      includes

Documentation

See timvink.github.io/mkdocs-git-revision-date-localized-plugin.

Contributing

Contributions are very welcome! Please read CONTRIBUTING.md before putting in any work.

Related MkDocs plugins:

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file mkdocs_git_revision_date_localized_plugin-1.5.4.tar.gz.

File metadata

File hashes

Hashes for mkdocs_git_revision_date_localized_plugin-1.5.4.tar.gz
Algorithm Hash digest
SHA256 07a785522008e881ff4c307e3259ad3ce00931b2d2147a22cdfbb532ff25e4ab
MD5 58af540887b8418e7b5368e458cf267c
BLAKE2b-256 06437c2f67a2ab0f9d2627d52a5a0a12b4206e4468a109ae7a091eeeb45f6825

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_git_revision_date_localized_plugin-1.5.4.tar.gz:

Publisher: pythonpublish.yml on timvink/mkdocs-git-revision-date-localized-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_git_revision_date_localized_plugin-1.5.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_git_revision_date_localized_plugin-1.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b5e6b4b9e7d169750b6eb078fd91151bc855e65c019a065accce537ec6e69e05
MD5 b9f043bb47301d6c475df6d112240643
BLAKE2b-256 0c7ca19cdb6e1c6f033cd35df847688f99c4f9b80b626fad87483f2069a6dc5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_git_revision_date_localized_plugin-1.5.4-py3-none-any.whl:

Publisher: pythonpublish.yml on timvink/mkdocs-git-revision-date-localized-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.5.4 This release

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.12.1

2 files

0.12

2 files

0.11.1

2 files

0.11

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.3

2 files

0.9.2

2 files

0.9

2 files

0.8

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7

2 files

0.6

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.8

2 files

0.4.6

2 files

0.4.5

2 files

0.4.3

2 files

0.4.2

2 files

0.4

2 files

0.3.3

2 files

0.3.1

2 files

0.2.1

2 files

0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page