From 1d1e280282a73d997be62f0efa61000b6b67e172 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Sun, 10 Jun 2018 19:44:56 -0400 Subject: [PATCH] Add documentation for IP-API modules --- _site/content/posts/modules/ipapi.md | 60 +++++++++ docs/index.xml | 17 ++- docs/posts/index.html | 7 ++ docs/posts/index.xml | 17 ++- docs/posts/modules/ipapi/index.html | 177 +++++++++++++++++++++++++++ docs/sitemap.xml | 9 +- 6 files changed, 283 insertions(+), 4 deletions(-) create mode 100644 _site/content/posts/modules/ipapi.md create mode 100644 docs/posts/modules/ipapi/index.html diff --git a/_site/content/posts/modules/ipapi.md b/_site/content/posts/modules/ipapi.md new file mode 100644 index 00000000..e93c3410 --- /dev/null +++ b/_site/content/posts/modules/ipapi.md @@ -0,0 +1,60 @@ +--- +title: "IP API" +date: 2018-06-10T19:41:52-04:00 +draft: false +--- + +Displays your current IP address information, from [IP-APIcom](http://ip-api.com). + +**Note:** IP-API.com has a free-plan rate limit of 120 requests per +minute. + +## Source Code + +```bash +wtf/ipapi/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +ipinfo: + colors: + name: red + value: white + enabled: true + position: + top: 1 + left: 2 + height: 1 + width: 1 + refreshInterval: 150 +``` +### Attributes + +`colors.name`
+The default colour for the row names.
+Values: Any X11 color name. + +`colors.value`
+The default colour for the row values.
+Values: Any X11 color name. + +`enabled`
+Determines 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.
+Values: A positive integer, `0..n`. diff --git a/docs/index.xml b/docs/index.xml index 0259bfcb..0da6f5b2 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 - Sun, 10 Jun 2018 19:26:08 -0400 + Sun, 10 Jun 2018 19:41:52 -0400 + + IP API + https://wtfutil.com/posts/modules/ipapi/ + Sun, 10 Jun 2018 19:41:52 -0400 + + https://wtfutil.com/posts/modules/ipapi/ + Displays your current IP address information, from IP-APIcom. +Note: IP-API.com has a free-plan rate limit of 120 requests per minute. +Source Code wtf/ipapi/ Required ENV Variables None. +Keyboard Commands None. +Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:150 Attributes colors.name The default colour for the row names. Values: Any X11 color name. +colors.value The default colour for the row values. Values: Any X11 color name. +enabled Determines whether or not this module is executed and if its data displayed onscreen. + + CircleCI https://wtfutil.com/posts/modules/circleci/ diff --git a/docs/posts/index.html b/docs/posts/index.html index ddb5c845..80f562b5 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -101,6 +101,13 @@

Posts

  • + + IP API + + + + +
  • CircleCI diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 9a86c641..f5d9073c 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -6,11 +6,26 @@ Recent content in Posts on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Sun, 10 Jun 2018 19:26:08 -0400 + Sun, 10 Jun 2018 19:41:52 -0400 + + IP API + https://wtfutil.com/posts/modules/ipapi/ + Sun, 10 Jun 2018 19:41:52 -0400 + + https://wtfutil.com/posts/modules/ipapi/ + Displays your current IP address information, from IP-APIcom. +Note: IP-API.com has a free-plan rate limit of 120 requests per minute. +Source Code wtf/ipapi/ Required ENV Variables None. +Keyboard Commands None. +Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:150 Attributes colors.name The default colour for the row names. Values: Any X11 color name. +colors.value The default colour for the row values. Values: Any X11 color name. +enabled Determines whether or not this module is executed and if its data displayed onscreen. + + CircleCI https://wtfutil.com/posts/modules/circleci/ diff --git a/docs/posts/modules/ipapi/index.html b/docs/posts/modules/ipapi/index.html new file mode 100644 index 00000000..d8fca0a5 --- /dev/null +++ b/docs/posts/modules/ipapi/index.html @@ -0,0 +1,177 @@ + + + + + + + + + + + + +IP API | WTF - A Terminal Dashboard + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + WFT Logo +

    + +

    +
    + + + +

    + © 2018 Chris Cummer. +
    + Some Rights Reserved. + +

    +
    +
    + +
    +
    +

    IP API

    + +
    + + + + Jun 10, 2018 + + + + +
    + +     +
    + + + +

    Displays your current IP address information, from IP-APIcom.

    + +

    Note: IP-API.com has a free-plan rate limit of 120 requests per +minute.

    + +

    Source Code

    +
    wtf/ipapi/
    +

    Required ENV Variables

    + +

    None.

    + +

    Keyboard Commands

    + +

    None.

    + +

    Configuration

    +
    ipinfo:
+  colors:
+    name: red
+    value: white
+  enabled: true
+  position:
+    top: 1
+    left: 2
+    height: 1
+    width: 1
+  refreshInterval: 150
    +

    Attributes

    + +

    colors.name
    +The default colour for the row names.
    +Values: Any X11 color name.

    + +

    colors.value
    +The default colour for the row values.
    +Values: Any X11 color name.

    + +

    enabled
    +Determines 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.
    +Values: A positive integer, 0..n.

    + +
    + +
    + + + +
    +
    + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 6a767e8e..c1512d5f 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + https://wtfutil.com/posts/modules/ipapi/ + 2018-06-10T19:41:52-04:00 + + https://wtfutil.com/posts/modules/circleci/ 2018-06-10T19:26:08-04:00 @@ -144,7 +149,7 @@ https://wtfutil.com/posts/ - 2018-06-10T19:26:08-04:00 + 2018-06-10T19:41:52-04:00 0 @@ -155,7 +160,7 @@ https://wtfutil.com/ - 2018-06-10T19:26:08-04:00 + 2018-06-10T19:41:52-04:00 0