Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add support for mkdocs-git-revision-date-plugin

See original GitHub issue

I checked that…

… the documentation does not mention anything about my idea
… to my best knowledge, my idea wouldn’t break something for other users
… there are no open or closed issues that are related to my idea

Description

Add support for mkdocs-git-committers-plugin. In effect, when a user enables the plugin in mkdocs.yml, the latest revision date would automatically display under the page title.

Use Cases

Users can see clearly when pages where last updated – without having to go to git.

Screenshots / Mockups

It would look something like this:

If this is something that is considered useful I would be happy to work on the PR. Work to be done:

Update base.html with conditional statements
Some CSS work
Update documentation page with supported extensions

Issue Analytics

State:
Created 4 years ago
Reactions:4
Comments:32 (32 by maintainers)

Top GitHub Comments

3reactions

timvinkcommented, Dec 16, 2019

Hi @RDIL

Happy to hear you’d like to use it!

You have an error in your config, as you added a plugin under markdown-extensions. Instead, add a new section with:

plugins:
  - git-revision-date-localized
      type: timeago

and if you use search, you need to explictly enable it under plugins as well, i.e.:

plugins:
  - search
  - git-revision-date-localized
      type: timeago

If you have any issues with the plugin you can open an issue at mkdocs-git-revision-date-localized-plugin

1reaction

squidfunkcommented, Dec 11, 2019

Thanks for your contributions! Pleasure to work with you. The changes were just released with 4.6.0.

Top Results From Across the Web

zhaoterryy/mkdocs-git-revision-date-plugin - GitHub

mkdocs -git-revision-date-plugin. MkDocs plugin that displays the last revision date of the current page of the documentation based on Git. The revision date...

mkdocs-git-revision-date-plugin - PyPI

MkDocs plugin for setting revision date from git per markdown file.

Options - mkdocs-git-revision-date-localized-plugin

Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.

mkdocs-git-revision-date-localized-plugin - Python package

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

mkdocs-git-revision-date-plugin: Documentation | Openbase

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables...