Automatically show 'last update' date #1743
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose / why
Automatically show date of last updates on each documentation page. Proof of concept for using Materials theme feature based on plugin.
What changes were made?
Included and activated git-revision-date-localized (https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) plugin for MkDocs. With the plugin active, each documentation page will show a 'last updated' date at the bottom, based on the page's Git revision history.
Important: If you want to test this locally, you must first install the plugin with
pip install mkdocs-git-revision-date-localized-plugin
, otherwise the build will fail.Placing the date at the top of the page might involve modifying the Materials theme. It's possible to manually add a variable command showing the date at any location on the page.
Verification
Interested Parties
@dannylamb @manez @highermath
Checklist