1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add basic documentation for Git commit message format configuration

This commit is contained in:
Chris Cummer
2018-06-15 16:54:07 -07:00
parent 32ed793599
commit dcbc541221
2 changed files with 18 additions and 0 deletions

View File

@@ -54,6 +54,8 @@ None.
```yaml
git:
commitCount: 5
commitFormat: "[forestgreen]%h [grey]%cd [white]%s [grey]%an[white]"
dateFormat: "%H:%M %d %b %y"
enabled: true
position:
top: 0
@@ -72,6 +74,13 @@ git:
The number of past commits to display. <br />
Values: A positive integer, `0..n`.
`commitFormat` <br />
_Optional_ The string format for the commit message. <br />
`dateFormat` <br />
_Optional_ The string format for the date/time in the commit message.
<br />
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.