Skip to content

Commit f7a4f4f

Browse files
doc updates
1 parent a310cc8 commit f7a4f4f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/options.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ plugins:
99
show_line_count: true
1010
count_empty_lines: true
1111
fallback_to_empty: false
12+
sort_authors_by: name
13+
authorship_threshold_percent: 10
1214
exclude:
1315
- index.md
1416
enabled: true
@@ -52,6 +54,14 @@ plugins:
5254
- folder/*
5355
```
5456

57+
## `sort_authors_by`
58+
59+
Defaults to `name`, can be `contribution` to sort the authors by contribution percentage without needing to show the exact percent.
60+
61+
## `authorship_threshold_percent`
62+
63+
Default is `0%`. This option sets the minimum contribution percentage for an author to be included in the list of authors. This can be useful when you have a large number of single line authors who contributed minor spelling fixes, and not major content. This option does not apply if there is only one author.
64+
5565
## `enabled`
5666

5767
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:

0 commit comments

Comments
 (0)