Add basic documentation for Git commit message format configuration

wtfutil · Jun 15, 2018 · dcbc541 · dcbc541
1 parent 32ed793
commit dcbc541
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/_site/content/posts/modules/git.md b/_site/content/posts/modules/git.md
@@ -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`.

diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html
@@ -163,6 +163,8 @@ <h2 id="keyboard-commands">Keyboard Commands</h2>
 <h2 id="configuration">Configuration</h2>
 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">git<span class="p">:</span><span class="w">
 </span><span class="w">  </span>commitCount<span class="p">:</span><span class="w"> </span><span class="m">5</span><span class="w">
+</span><span class="w">  </span>commitFormat<span class="p">:</span><span class="w"> </span><span class="s2">&#34;[forestgreen]%h [grey]%cd [white]%s [grey]%an[white]&#34;</span><span class="w">
+</span><span class="w">  </span>dateFormat<span class="p">:</span><span class="w"> </span><span class="s2">&#34;%H:%M %d %b %y&#34;</span><span class="w">
 </span><span class="w">  </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
 </span><span class="w">  </span>position<span class="p">:</span><span class="w">
 </span><span class="w">    </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
@@ -179,6 +181,13 @@ <h3 id="attributes">Attributes</h3>
 The number of past commits to display. <br />
 Values: A positive integer, <code>0..n</code>.</p>
 
+<p><code>commitFormat</code> <br />
+<em>Optional</em> The string format for the commit message. <br /></p>
+
+<p><code>dateFormat</code> <br />
+<em>Optional</em> The string format for the date/time in the commit message.
+<br /></p>
+
 <p><code>enabled</code> <br />
 Determines whether or not this module is executed and if its data displayed onscreen. <br />
 Values: <code>true</code>, <code>false</code>.</p>