You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ This plugin needs access to the last commit that touched a specific file to be a
48
48
49
49
### In supported themes
50
50
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)
52
52
53
53
### In markdown pages
54
54
@@ -62,15 +62,15 @@ Last update: {{ git_revision_date_localized }}
62
62
63
63
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.
64
64
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:
66
66
67
67
```yml
68
68
theme:
69
69
name: mkdocs
70
70
custom_dir: docs/overrides
71
71
```
72
72
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:
74
74
75
75
<details>
76
76
<summary>content.html</summary>
@@ -99,7 +99,7 @@ And then adding a new file `docs/overrides/content.html` with the following cont
99
99
100
100
### In custom themes
101
101
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:
103
103
104
104
```django hljs
105
105
{% if page.meta.git_revision_date_localized %}
@@ -121,7 +121,7 @@ plugins:
121
121
locale: en
122
122
fallback_to_build_date: false
123
123
exclude:
124
-
- index.md
124
+
- index.md
125
125
```
126
126
127
127
### `type`
@@ -150,7 +150,7 @@ Default is `None`. Specify a two letter [ISO639](https://en.wikipedia.org/wiki/L
150
150
151
151
### `fallback_to_build_date`
152
152
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.
0 commit comments