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

Add index to Configuration documentation page

This commit is contained in:
Chris Cummer 2018-06-04 04:27:57 -07:00
parent 64f8dbcf8d
commit 9e77c8aa3d
6 changed files with 27 additions and 3 deletions

View File

@ -4,6 +4,12 @@ date: 2018-04-15T21:17:16-07:00
draft: false
---
## Index
* [Configuration Files](#configuration-files)
* [Environment (ENV) Variables](#environment-env-variables)
* [Grid Layout](#grid-layout)
## Configuration Files
By default WTF looks in a `~/.wtf/` directory for a YAML file called
@ -66,7 +72,7 @@ Columns breaks up the width of the screen into chunks, each chunk a specified nu
Ten columns that are ten characters wide
Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:
Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:
`[10, 10, 10, 10, 18]`

View File

@ -27,6 +27,11 @@ span.caption {
text-align: right;
}
ul {
line-height: 22px !important;
margin-bottom: 14px !important;
}
.disabled {
color: gray !important;
cursor: not-allowed;

View File

@ -27,6 +27,11 @@ span.caption {
text-align: right;
}
ul {
line-height: 22px !important;
margin-bottom: 14px !important;
}
.disabled {
color: gray !important;
cursor: not-allowed;

View File

@ -329,7 +329,7 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>https://wtfutil.com/posts/configuration/</guid>
<description>Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item>

View File

@ -112,6 +112,14 @@
<h2 id="index">Index</h2>
<ul>
<li><a href="#configuration-files">Configuration Files</a></li>
<li><a href="#environment-env-variables">Environment (ENV) Variables</a></li>
<li><a href="#grid-layout">Grid Layout</a></li>
</ul>
<h2 id="configuration-files">Configuration Files</h2>
<p>By default WTF looks in a <code>~/.wtf/</code> directory for a YAML file called

View File

@ -329,7 +329,7 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>https://wtfutil.com/posts/configuration/</guid>
<description>Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item>