@@ -339,8 +434,13 @@
+ Index
@@ -378,16 +478,6 @@ parameter on launch:A number of top-level attributes can be set to customize your WTF install. See Attributes for details.
-Environment (ENV) Variables
- -Some modules require the presence of environment variables to function -properly. Usually these are API keys or other sensitive data that one -wouldn’t want to have laying about in the config files.
- -For modules that require them, the name of the required environment -variable(s) can be found in that module’s “Required ENV Variables” -section of the documentation. See OpsGenie for an example.
-Grid Layout
WTF uses the Grid layout system from tview to position widgets
@@ -408,10 +498,10 @@ explanation:
The co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we’d position it at:
- top: 4 // top starts in the 4th row
- left: 9 // left starts in the 9th column
+ top: 4 // top starts in the 4th row
+ left: 9 // left starts in the 9th column
height: 2 // span down rows 4 & 5 (18 characters in size, total)
- width: 2 // span across cols 9 & 10 (20 characters in size, total)
+ width: 2 // span across cols 9 & 10 (20 characters in size, total)
diff --git a/_site/public/index.html b/_site/public/index.html
index 8859a75c..c07acbe5 100644
--- a/_site/public/index.html
+++ b/_site/public/index.html
@@ -428,6 +428,8 @@
navigation
+WTF
+
WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
diff --git a/_site/public/index.json b/_site/public/index.json
index f9f468cb..cde34f9f 100644
--- a/_site/public/index.json
+++ b/_site/public/index.json
@@ -25,7 +25,7 @@
"title": "Configuration",
"tags": [],
"description": "",
- "content": " Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn\u0026rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.\nIn other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml.\nExample Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.\nTo try out WTF quickly, copy simple_config.yml into ~/.config/wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security, Clocks and Status widgets onscreen.\nCustom Configuration Files To try out different configurations (or run multiple instances of WTF), you can pass the path to a config file via command line arguments on start-up.\nTo load a custom configuration file (ie: one that\u0026rsquo;s not ~/.config/wtf/config.yml), pass in the path to configuration file as a parameter on launch:\n$\u0026gt; wtf --config=path/to/custom/config.yml Configuration Attributes A number of top-level attributes can be set to customize your WTF install. See Attributes for details.\nEnvironment (ENV) Variables Some modules require the presence of environment variables to function properly. Usually these are API keys or other sensitive data that one wouldn\u0026rsquo;t want to have laying about in the config files.\nFor modules that require them, the name of the required environment variable(s) can be found in that module\u0026rsquo;s \u0026ldquo;Required ENV Variables\u0026rdquo; section of the documentation. See OpsGenie for an example.\nGrid Layout WTF uses the Grid layout system from tview to position widgets onscreen. It\u0026rsquo;s not immediately obvious how this works, so here\u0026rsquo;s an explanation:\nThink of your terminal screen as a matrix of letter positions, say 100 chrs wide and 58 chrs tall.\nColumns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use\n[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]\nTen columns that are ten characters wide\nRows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:\n[10, 10, 10, 10, 18]\nThe co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we\u0026rsquo;d position it at:\n top: 4 // top starts in the 4th row left: 9 // left starts in the 9th column height: 2 // span down rows 4 \u0026amp; 5 (18 characters in size, total) width: 2 // span across cols 9 \u0026amp; 10 (20 characters in size, total) "
+ "content": " Index Configuration Files Example Configuration Files Custom Configuration Files Configuration Attributes Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn\u0026rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.\nIn other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml.\nExample Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.\nTo try out WTF quickly, copy simple_config.yml into ~/.config/wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security, Clocks and Status widgets onscreen.\nCustom Configuration Files To try out different configurations (or run multiple instances of WTF), you can pass the path to a config file via command line arguments on start-up.\nTo load a custom configuration file (ie: one that\u0026rsquo;s not ~/.config/wtf/config.yml), pass in the path to configuration file as a parameter on launch:\n$\u0026gt; wtf --config=path/to/custom/config.yml Configuration Attributes A number of top-level attributes can be set to customize your WTF install. See Attributes for details.\nGrid Layout WTF uses the Grid layout system from tview to position widgets onscreen. It\u0026rsquo;s not immediately obvious how this works, so here\u0026rsquo;s an explanation:\nThink of your terminal screen as a matrix of letter positions, say 100 chrs wide and 58 chrs tall.\nColumns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use\n[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]\nTen columns that are ten characters wide\nRows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:\n[10, 10, 10, 10, 18]\nThe co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we\u0026rsquo;d position it at:\n top: 4 // top starts in the 4th row left: 9 // left starts in the 9th column height: 2 // span down rows 4 \u0026amp; 5 (18 characters in size, total) width: 2 // span across cols 9 \u0026amp; 10 (20 characters in size, total) "
},
{
"uri": "/modules/cryptocurrencies/blockfolio/",
@@ -298,7 +298,7 @@
"title": "WTF",
"tags": [],
"description": "",
- "content": "WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.\nIt allows you to monitor systems, services, and important information that you otherwise might keep browser tabs open for, the kinds of things you don\u0026rsquo;t always need visible, but do check in on every now and then.\nKeep an eye on your OpsGenie schedules, Google Calendar, Git and GitHub repositories, and New Relic deployments.\nSee who\u0026rsquo;s away in BambooHR, which Jira tickets are assigned to you, and what time it is in Barcelona.\nIt even has weather. And clocks. And emoji.\n"
+ "content": "WTF WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.\nIt allows you to monitor systems, services, and important information that you otherwise might keep browser tabs open for, the kinds of things you don\u0026rsquo;t always need visible, but do check in on every now and then.\nKeep an eye on your OpsGenie schedules, Google Calendar, Git and GitHub repositories, and New Relic deployments.\nSee who\u0026rsquo;s away in BambooHR, which Jira tickets are assigned to you, and what time it is in Barcelona.\nIt even has weather. And clocks. And emoji.\n"
},
{
"uri": "/getting_started/installation/",
diff --git a/_site/public/modules/index.html b/_site/public/modules/index.html
index dc3d8f65..17a5e6fb 100644
--- a/_site/public/modules/index.html
+++ b/_site/public/modules/index.html
@@ -141,6 +141,35 @@
CmdRunner