Skip to content

Commit 2e7646e

Browse files
authored
update to v1.3
1 parent 1e69247 commit 2e7646e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

Diff for: docs/options.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ You can customize the plugin by setting options in `mkdocs.yml`. For example:
1515
enable_creation_date: true
1616
exclude:
1717
- index.md
18+
enable_git_follow: true
1819
enabled: true
1920
strict: true
2021
```
@@ -114,6 +115,13 @@ Default is empty. Specify a list of page source paths (one per line) that should
114115
- folder/*
115116
```
116117

118+
## `enable_git_follow`
119+
120+
Default is `true`. When enabled it will use `git log --follow` to find the git history. This means git will follow changes if you rename or move the file also.
121+
Despite being a sensible default, there is a known bug with `--follow`: if you have committed an empty version of a file, then `git log --follow` can follow the wrong trail and give wrong results (see [this blogpost](https://blog.plover.com/prog/git-log-follow.html)).
122+
123+
When disabled (by setting it to `false`), each file's history will only consist of its current name and path, it's history from the previous paths or names will not be included.
124+
117125
## `enabled`
118126

119127
Default is `true`. Enables you to deactivate this plugin. A possible use case is local development where you might want faster build times and/or do not have git available. It's recommended to use this option with an environment variable together with a default fallback (introduced in `mkdocs` v1.2.1, see [docs](https://www.mkdocs.org/user-guide/configuration/#environment-variables)). Example:
@@ -133,14 +141,6 @@ export ENABLED_GIT_REVISION_DATE=false
133141
mkdocs serve
134142
```
135143

136-
## `enable_git_follow`
137-
138-
Default is `true`. When enabled it will issue `--follow` option for git history tracing; meaning it will also track file's previous history for rename and move operations.
139-
140-
When disabled (by setting it to `false`), each file's history will only consist of its current name and path, it's history from the previous paths or names will not be included.
141-
142-
When enabled (by setting it to `true`), history tracking with `--follow` will be enabled and history will include the file's history from rename and other paths.
143-
144144
## `strict`
145145

146146
Default is `true`. When enabled, the logs will show warnings when something is wrong but a fallback has been used. When disabled, the logger will use the INFO level instead.
+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "1.2.9"
1+
__version__ = "1.3.0"

0 commit comments

Comments
 (0)