Skip to content

Commit 582fe6f

Browse files
fundthmcalculustimvink
authored andcommitted
doc updates
1 parent 60249c3 commit 582fe6f

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
@@ -10,6 +10,8 @@ plugins:
1010
show_email_address: true
1111
count_empty_lines: true
1212
fallback_to_empty: false
13+
sort_authors_by: name
14+
authorship_threshold_percent: 10
1315
exclude:
1416
- index.md
1517
enabled: true
@@ -59,6 +61,14 @@ plugins:
5961
- folder/*
6062
```
6163

64+
## `sort_authors_by`
65+
66+
Defaults to `name`, can be `contribution` to sort the authors by contribution percentage without needing to show the exact percent.
67+
68+
## `authorship_threshold_percent`
69+
70+
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.
71+
6272
## `enabled`
6373

6474
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)