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

Generate the documentation for the new config changes

This commit is contained in:
Chris Cummer
2018-07-31 15:37:02 -07:00
parent b6036a3eae
commit da9b863625
10 changed files with 101 additions and 100 deletions

View File

@@ -143,15 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/trello/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_TRELLO_APP_KEY</code> <br />
<span class="caption">Value:</span> Your Trello App Key. <br />
<span class="caption">Key:</span> <code>WTF_TRELLO_ACCESS_TOKEN</code> <br />
<span class="caption">Value:</span> Your Trello Access Token. <br /></p>
<p><em>You can get your API key at: trello.com/app-key.</em></p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p>
@@ -159,11 +150,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2>
<h3 id="single-trello-list">Single Trello List</h3>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
</span><span class="w"> </span>accessToken<span class="p">:</span><span class="w"> </span><span class="s2">&#34;7b8b14f8743a408a93276d7155dd9ee2&#34;</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<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>list<span class="p">:</span><span class="w"> </span><span class="s2">&#34;Todo&#34;</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">2</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">
@@ -174,11 +167,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p>If you want to monitor multiple Trello lists, use the following
configuration (note the difference in <code>list</code>):</p>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
</span><span class="w"> </span>accessToken<span class="p">:</span><span class="w"> </span><span class="s2">&#34;7b8b14f8743a408a93276d7155dd9ee2&#34;</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<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>list<span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&#34;Todo&#34;</span><span class="p">,</span><span class="w"> </span><span class="s2">&#34;Done&#34;</span><span class="p">]</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">2</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">
@@ -187,6 +182,12 @@ configuration (note the difference in <code>list</code>):</p>
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span>myname</code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>accessToken</code> <br />
Value: Your Trello access token.</p>
<p><code>apiKey</code> <br />
Value: Your Trello API key.</p>
<p><code>board</code> <br />
The name of the Trello board. <br /></p>