Skip to content

Commit eeb9f12

Browse files
committed
Improve README and bump version to 0.8
1 parent aee67a6 commit eeb9f12

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This plugin needs access to the last commit that touched a specific file to be a
4848

4949
### In supported themes
5050

51-
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) offers native support for this plugin, see [setup instructions](https://squidfunk.github.io/mkdocs-material/plugins/revision-date/)
51+
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) offers native support for this plugin, see [setup instructions](https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#revision-date-localized)
5252

5353
### In markdown pages
5454

@@ -62,15 +62,15 @@ Last update: {{ git_revision_date_localized }}
6262

6363
You can [customize an existing theme](https://www.mkdocs.org/user-guide/styling-your-docs/#customizing-a-theme) by overriding blocks or partials and using the `page.meta.git_revision_date_localized` tag.
6464

65-
To add a revision date to the default `mkdocs` theme by adding a `overrides/partials` folder to your `docs` folder and updating your `mkdocs.yml` file:
65+
To add a revision date to the default `mkdocs` theme, add a `overrides/partials` folder to your `docs` folder and update your `mkdocs.yml` file:
6666

6767
```yml
6868
theme:
6969
name: mkdocs
7070
custom_dir: docs/overrides
7171
```
7272

73-
And then adding a new file `docs/overrides/content.html` with the following content:
73+
And then add a new file `docs/overrides/content.html` with the following content:
7474

7575
<details>
7676
<summary>content.html</summary>
@@ -99,7 +99,7 @@ And then adding a new file `docs/overrides/content.html` with the following cont
9999

100100
### In custom themes
101101

102-
When writing your own [custom themes](https://www.mkdocs.org/user-guide/custom-themes/) you can use the `page.meta.git_revision_date_localized` jinja tag:
102+
When writing your own [custom themes](https://www.mkdocs.org/user-guide/custom-themes/) you can use the `page.meta.git_revision_date_localized` jinja tag, like so for example:
103103

104104
```django hljs
105105
{% if page.meta.git_revision_date_localized %}
@@ -121,7 +121,7 @@ plugins:
121121
locale: en
122122
fallback_to_build_date: false
123123
exclude:
124-
- index.md
124+
- index.md
125125
```
126126

127127
### `type`
@@ -150,7 +150,7 @@ Default is `None`. Specify a two letter [ISO639](https://en.wikipedia.org/wiki/L
150150

151151
### `fallback_to_build_date`
152152

153-
Default is `false`. If set to `true` the plugin will use the time at `mkdocs build` instead of the file's last git revision date *when git is not available*. This means the revision date can be incorrect, but this can be acceptable if you want your project to also successfully build in environments with no access to GIT.
153+
Default is `false`. If set to `true` the plugin will use the time at `mkdocs build` instead of the file's last git revision date *when git is not available*. This means the revision date will be incorrect, but this can be acceptable if you want your project to also successfully build in environments with no access to GIT.
154154

155155
### `exclude`
156156

Diff for: setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
setup(
1414
name="mkdocs-git-revision-date-localized-plugin",
15-
version="0.7.4",
15+
version="0.8",
1616
description="Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.",
1717
long_description=LONG_DESCRIPTION,
1818
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)