You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/options.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ plugins:
9
9
show_line_count: true
10
10
count_empty_lines: true
11
11
fallback_to_empty: false
12
+
sort_authors_by: name
13
+
authorship_threshold_percent: 10
12
14
exclude:
13
15
- index.md
14
16
enabled: true
@@ -52,6 +54,14 @@ plugins:
52
54
- folder/*
53
55
```
54
56
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
+
55
65
## `enabled`
56
66
57
67
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