Skip to content

Commit e01a84a

Browse files
committed
Merge branch 'master' of github.com:timvink/mkdocs-git-revision-date-localized-plugin
2 parents eeb9f12 + 654a126 commit e01a84a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This plugin needs access to the last commit that touched a specific file to be a
3939
<summary>Change your CI settings</summary>
4040

4141
- github actions: set `fetch_depth` to `0` ([docs](https://github.com/actions/checkout))
42-
- gitlab runners: set `GIT_DEPTH` to `1000` ([docs](https://docs.gitlab.com/ee/user/project/pipelines/settings.html#git-shallow-clone))
42+
- gitlab runners: set `GIT_DEPTH` to `0` ([docs](https://docs.gitlab.com/ee/user/project/pipelines/settings.html#git-shallow-clone))
4343
- bitbucket pipelines: set `clone: depth: full` ([docs](https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/))
4444
</details>
4545

@@ -117,7 +117,7 @@ You can customize the plugin by setting options in `mkdocs.yml`. For example:
117117
plugins:
118118
- git-revision-date-localized:
119119
type: timeago
120-
time_zone: Europe/Amsterdam
120+
timezone: Europe/Amsterdam
121121
locale: en
122122
fallback_to_build_date: false
123123
exclude:
@@ -136,7 +136,7 @@ Default is `date`. To change the date format, set the `type` parameter to one of
136136
20 hours ago # type: timeago
137137
```
138138

139-
### `time_zone`
139+
### `timezone`
140140

141141
Default is `UTC`. Specify a time zone database name ([reference](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)). This option is especially relevant when using `type: datetime` and `type: iso_datetime`. Note that when using [timeago](http://timeago.yarp.com/) (with `type: timeago`) any difference in time zones between server and client will be handled automatically.
142142

0 commit comments

Comments
 (0)