Skip to content

Commit 6f3875c

Browse files
authored
Document new strict option
1 parent f59b6d0 commit 6f3875c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/options.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ plugins:
1515
exclude:
1616
- index.md
1717
enabled: true
18+
strict: true
1819
```
1920
2021
## `show_contribution`
@@ -86,3 +87,18 @@ Which enables you do disable the plugin locally using:
8687
export ENABLED_GIT_AUTHORS=false
8788
mkdocs serve
8889
```
90+
91+
## `strict`
92+
93+
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.
94+
95+
- If you want to raise an error when a warning is logged, use [mkdocs strict mode](https://www.mkdocs.org/user-guide/configuration/#strict) (with `mkdocs build --strict`).
96+
- If you are already using [mkdocs strict mode](https://www.mkdocs.org/user-guide/configuration/#strict), but do not care about these warnings, you can set `strict: false` to ensure no errors are raised.
97+
98+
=== ":octicons-file-code-16: mkdocs.yml"
99+
100+
```yaml
101+
plugins:
102+
- git-authors:
103+
strict: true
104+
```

0 commit comments

Comments
 (0)