Skip to content

Commit afe21bf

Browse files
authored
clarify intro & add pointer to timvink's fork
1 parent 964998b commit afe21bf

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# mkdocs-git-revision-date-plugin
22

3-
MkDocs plugin for setting revision date from git per markdown file.
3+
MkDocs plugin that displays the last revision date of the current page of the documentation based on Git. The revision date will be displayed in ISO format *(YYYY-mm-dd)*. If you need other date formats check out [timvink's fork][mkdocs-git-revision-date-localized-plugin]
44

55
## Setup
66
Install the plugin using pip:
@@ -19,7 +19,6 @@ plugins:
1919
More information about plugins in the [MkDocs documentation][mkdocs-plugins].
2020

2121
## Usage
22-
The revision date will be displayed in ISO format *(YYYY-mm-dd)*.
2322

2423
### Templates - `page.meta.revision_date`:
2524
#### Example
@@ -60,6 +59,7 @@ plugins:
6059
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
6160
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
6261
[mkdocs-macro]: https://github.com/fralau/mkdocs_macros_plugin
62+
[mkdocs-git-revision-date-localized-plugin]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
6363

6464
## Options
6565

@@ -73,4 +73,4 @@ Setting this option to false will disable the use of `{{ git_revision_date }}` i
7373

7474
### `as_datetime`
7575

76-
Setting this option to True will output git_revision_date as a python `datetime`. This means you can use jinja2 date formatting, for example as `{{ git_revision_date.strftime('%d %B %Y') }}`. Default is false.
76+
Setting this option to True will output git_revision_date as a python `datetime`. This means you can use jinja2 date formatting, for example as `{{ git_revision_date.strftime('%d %B %Y') }}`. Default is false.

0 commit comments

Comments
 (0)