Skip to content

Commit 89ea58e

Browse files
authored
Document show_contribution option
1 parent 71e8578 commit 89ea58e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,17 @@ An example of how to use in your templates:
8585
```
8686

8787
Alternatively, you could use the simple preformatted ``{{ git_authors_summary }}`` to insert a summary of the authors.
88+
89+
## Options
90+
91+
### `show_contribution`
92+
93+
If this option is set to `true` (default: `false`) The contribution to a page is
94+
printed as a percentage of (source file) lines per author. The output is
95+
suppressed if there is only *one* author for a page.
96+
97+
Example output:
98+
99+
* Authors: [John Doe](#) (33.33%), [Jane Doe](#) (66.67%) *(more than one author)*
100+
* Authors: [John Doe](#) *(one author)*
101+

0 commit comments

Comments
 (0)