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

Clean up the Todoist documentation a bit

This commit is contained in:
Chris Cummer 2018-07-11 13:46:43 -07:00
parent 2f2446a424
commit 3d304e7256
2 changed files with 19 additions and 17 deletions

View File

@ -32,7 +32,7 @@ _You can get your API Token at: todoist.com/prefs/integrations._
<span class="caption">Action:</span←> Show the previous project.
<span class="caption">Key:</span> `l` <br />
<span class="caption">Action:</span←> Show the next project.
<span class="caption">Action:</span> Show the next project.
<span class="caption">Key:</span> `→` <br />
<span class="caption">Action:</span> Show the next project.
@ -62,14 +62,14 @@ _You can get your API Token at: todoist.com/prefs/integrations._
```yaml
todoist:
projects:
- project_id
enabled: true
position:
height: 1
left: 2
top: 0
left: 2
height: 1
width: 1
projects:
- 122247497
refreshInterval: 3600
```
@ -79,12 +79,13 @@ todoist:
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Where in the grid this module's widget will be displayed. <br />
`projects` <br />
The todoist projects to fetch items from. <br />
Values: The integer ID of the project.
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`position` <br />
Where in the grid this module's widget will be displayed. <br />

View File

@ -159,7 +159,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<span class="caption">Action:</span←> Show the previous project.</p>
<p><span class="caption">Key:</span> <code>l</code> <br />
<span class="caption">Action:</span←> Show the next project.</p>
<span class="caption">Action:</span> Show the next project.</p>
<p><span class="caption">Key:</span> <code></code> <br />
<span class="caption">Action:</span> Show the next project.</p>
@ -187,14 +187,14 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">todoist<span class="p">:</span><span class="w">
</span><span class="w"> </span>projects<span class="p">:</span><span class="w">
</span><span class="w"> </span>-<span class="w"> </span>project_id<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>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">
</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>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>projects<span class="p">:</span><span class="w">
</span><span class="w"> </span>-<span class="w"> </span><span class="m">122247497</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">3600</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
@ -202,16 +202,17 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br />
Where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>projects</code> <br />
The todoist projects to fetch items from. <br /></p>
The todoist projects to fetch items from. <br />
Values: The integer ID of the project.</p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0..n</code>.</p>
<p><code>position</code> <br />
Where in the grid this module&rsquo;s widget will be displayed. <br /></p>
</div>
<div class="footer">