From dfc34380efd55a10362416729ba60f35ca9559c1 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Wed, 1 Aug 2018 14:32:04 -0700 Subject: [PATCH] Update the Twitter documentation --- _site/content/posts/modules/gcal.md | 7 +- _site/content/posts/modules/twitter.md | 15 +- docs/index.xml | 19 ++- docs/posts/index.html | 7 + docs/posts/index.xml | 19 ++- docs/posts/modules/gcal/index.html | 7 +- docs/posts/modules/twitter/index.html | 189 +++++++++++++++++++++++++ docs/sitemap.xml | 9 +- 8 files changed, 258 insertions(+), 14 deletions(-) create mode 100644 docs/posts/modules/twitter/index.html diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index f8866481..6e4ec060 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -52,6 +52,7 @@ gcal: width: 1 refreshInterval: 300 secretFile: "~/.config/wtf/gcal/client_secret.json" + showDeclined: true withLocation: true ``` @@ -123,5 +124,9 @@ Your Google clien Values: A string representing a file path to the JSON secret file. `showDeclined`
-Whether or not to display events you've declined to attend.
+_Optional_. Whether or not to display events you've declined to attend.
+Values: `true`, or `false` + +`withLocation`
+Whether or not to show the location of the appointment.
Values: `true`, or `false` diff --git a/_site/content/posts/modules/twitter.md b/_site/content/posts/modules/twitter.md index dc3e17de..e19d9271 100644 --- a/_site/content/posts/modules/twitter.md +++ b/_site/content/posts/modules/twitter.md @@ -4,18 +4,17 @@ date: 2018-07-31T20:21:37-07:00 draft: false --- -Connects to the Twitter API and displays a single user's tweets -NOTE: This only works for single-application developer accounts for now +Added in `v0.1.2`. + +Connects to the Twitter API and displays a single user's tweets. + +NOTE: This only works for single-application developer accounts for now. ## Source Code ```bash wtf/twitter/ ``` -## Required ENV Variables - -Key: `WTF_TWITTER_BEARER_TOKEN`
-Action: Your Twitter single-application Bearer Token
## Keyboard Commands @@ -25,6 +24,7 @@ None. ```yaml twitter: + bearerToken: "3276d7155dd9ee27b8b14f8743a408a9" enabled: true position: top: 0 @@ -36,6 +36,9 @@ twitter: ### Attributes +`bearerToken`
+Value: Your Twitter single-application Bearer Token + `enabled`
Whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. diff --git a/docs/index.xml b/docs/index.xml index 5b9a2732..acee43b8 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,26 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Mon, 23 Jul 2018 18:55:37 -0800 + Tue, 31 Jul 2018 20:21:37 -0700 + + Twitter + https://wtfutil.com/posts/modules/twitter/ + Tue, 31 Jul 2018 20:21:37 -0700 + + https://wtfutil.com/posts/modules/twitter/ + Added in v0.1.2. +Connects to the Twitter API and displays a single user’s tweets. +NOTE: This only works for single-application developer accounts for now. +Source Code wtf/twitter/ Keyboard Commands None. +Configuration twitter:bearerToken:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token +enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. + + Zendesk https://wtfutil.com/posts/modules/zendesk/ @@ -374,7 +389,7 @@ board The name of the Trello board. enabled Determines whether or not this modul Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google’s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach. Source Code wtf/gcal/ Required ENV Variables None. Keyboard Commands None. -Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.config/wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.config/wtf/gcal/client_secret.json"showDeclined:truewithLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. diff --git a/docs/posts/index.html b/docs/posts/index.html index 01c37a30..a909ba5b 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -123,6 +123,13 @@ height="0" width="0" style="display:none;visibility:hidden">

Posts