Skip to content

Commit 8347eff

Browse files
authored
Add example of setting options for plugin
1 parent 03e87fe commit 8347eff

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,16 @@ Alternatively, you could use the simple pre-formatted `{{ git_page_authors }}` t
136136

137137
## Options
138138

139+
You can customize the plugin by setting options in `mkdocs.yml`. For example:
140+
141+
```yml
142+
plugins:
143+
- git-authors:
144+
show_contribution: true
145+
show_line_count: true
146+
count_empty_lines: true
147+
```
148+
139149
### `show_contribution`
140150

141151
If this option is set to `true` (default: `false`) the contribution of a author is

0 commit comments

Comments
 (0)