docs(plugins): clarification, fix typos and style

2022-07-04 23:18:01 -04:00
parent 3c00e64c57
commit 52ca4d04b7
47 changed files with 733 additions and 408 deletions
--- a/source/plugins/community/README.md
+++ b/source/plugins/community/README.md
@@ -99,9 +99,10 @@ Plugins are auto-loaded based on their folder existence, so there's no need to r

 The default file looks like below:
 ```yaml
-name: "🧩 Plugin name"
+name: 🧩 Plugin name
 category: community
-description: Short description
+description: |
+  Short description
 examples:
  default: https://via.placeholder.com/468x60?text=No%20preview%20available
 authors:
@@ -114,7 +115,8 @@ scopes: []
 inputs:

  plugin_{name}:
-    description: Enable {name} plugin
+    description: |
+      Enable {name} plugin
    type: boolean
    default: no
 ```
@@ -134,14 +136,16 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea
 *Example: boolean type, defaults to `false`*
 ```yml
  plugin_{name}_{option}:
-    description: Boolean type
+    description: |
+      Boolean type
    type: boolean
    default: no
 ```

 ```yml
  plugin_{name}_{option}:
-    description: String type
+    description: |
+      String type
    type: string
    default: .user.login
 ```
@@ -151,7 +155,8 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea
 *Example: string type, defaults to `foo` with `foo` or `bar` as allowed values*
 ```yml
  plugin_{name}_{option}:
-    description: Select type
+    description: |
+      Select type
    type: string
    values:
      - foo
@@ -164,7 +169,8 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea
 *Example: number type, defaults to `1` and expected to be between `0` and `100`*
 ```yml
  plugin_{name}_{option}:
-    description: Number type
+    description: |
+      Number type
    type: number
    default: 1
    min: 0
@@ -178,7 +184,8 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea
 *Example: array type, with comma-separated elements*
 ```yml
  plugin_{name}_{option}:
-    description: Array type
+    description: |
+      Array type
    type: array
    format: comma-separated
    values:
@@ -192,7 +199,8 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea
 *Example: json type*
 ```yml
  plugin_{name}_{option}:
-    description: JSON type
+    description: |
+      JSON type
    type: json
    default: |
      {
--- a/source/plugins/community/fortune/metadata.yml
+++ b/source/plugins/community/fortune/metadata.yml
@@ -1,6 +1,7 @@
-name: "🥠 Fortune"
+name: 🥠 Fortune
 category: community
-description: This plugins displays a random fortune message
+description: |
+  This plugins displays a random fortune message
 examples:
  default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.fortune.svg
 authors:
@@ -11,6 +12,7 @@ scopes: []
 inputs:

  plugin_fortune:
-    description: Enable fortune plugin
+    description: |
+      Enable fortune plugin
    type: boolean
    default: no
--- a/source/plugins/community/nightscout/metadata.yml
+++ b/source/plugins/community/nightscout/metadata.yml
@@ -1,6 +1,7 @@
-name: "💉 Nightscout"
+name: 💉 Nightscout
 category: community
-description: This plugin lets you display blood sugar values from a [Nightscout](http://nightscout.info) site.
+description: |
+  This plugin displays blood sugar values from a [Nightscout](http://nightscout.info) site.
 examples:
  default: https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg
 authors:
@@ -11,42 +12,49 @@ scopes: []
 inputs:

  plugin_nightscout:
-    description: Enable nightscout plugin
+    description: |
+      Enable nightscout plugin
    type: boolean
    default: no

  plugin_nightscout_url:
-    description: Nightscout URL
+    description: |
+      Nightscout URL
    type: string
    default: https://example.herokuapp.com

  plugin_nightscout_datapoints:
-    description: Number of datapoints shown the graph
+    description: |
+      Number of datapoints shown the graph
    type: number
    default: 12
    min: 0
    zero: disable

  plugin_nightscout_lowalert:
-    description: Threshold for low blood sugar
+    description: |
+      Threshold for low blood sugar
    type: number
    default: 80
    min: 0

  plugin_nightscout_highalert:
-    description: Threshold for high blood sugar
+    description: |
+      Threshold for high blood sugar
    type: number
    default: 180
    min: 0

  plugin_nightscout_urgentlowalert:
-    description: Threshold for urgently low blood sugar
+    description: |
+      Threshold for urgently low blood sugar
    type: number
    default: 50
    min: 0

  plugin_nightscout_urgenthighalert:
-    description: Threshold for urgently high blood sugar
+    description: |
+      Threshold for urgently high blood sugar
    type: number
    default: 250
    min: 0
--- a/source/plugins/community/poopmap/metadata.yml
+++ b/source/plugins/community/poopmap/metadata.yml
@@ -1,6 +1,7 @@
-name: "💩 PoopMap plugin"
+name: 💩 PoopMap plugin
 category: community
-description: This plugin displays statistics from a [PoopMap](https://poopmap.net) account.
+description: |
+  This plugin displays statistics from a [PoopMap](https://poopmap.net) account.
 examples:
  default: https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg
 authors:
@@ -11,17 +12,20 @@ scopes: []
 inputs:

  plugin_poopmap:
-    description: Enable poopmap plugin
+    description: |
+      Enable poopmap plugin
    type: boolean
    default: no

  plugin_poopmap_token:
-    description: PoopMap API token
+    description: |
+      PoopMap API token
    type: token
    default: ""

  plugin_poopmap_days:
-    description: Time range
+    description: |
+      Time range
    type: number
    values:
      - 7
--- a/source/plugins/community/screenshot/metadata.yml
+++ b/source/plugins/community/screenshot/metadata.yml
@@ -1,8 +1,9 @@
-name: "📸 Website screenshot"
+name: 📸 Website screenshot
 category: community
 description: |
-  This plugin display a screenshot from any website.
-  It can either the full page or a portion restricted by a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors).
+  This plugin displays a screenshot from any website.
+
+  It can either show the full page or a portion restricted by a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors).
 examples:
  default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg
 authors:
@@ -15,27 +16,32 @@ scopes: []
 inputs:

  plugin_screenshot:
-    description: Enable screenshot plugin
+    description: |
+      Enable screenshot plugin
    type: boolean
    default: no

  plugin_screenshot_title:
-    description: Title caption
+    description: |
+      Title caption
    type: string
    default: Screenshot

  plugin_screenshot_url:
-    description: Website url
+    description: |
+      Website URL
    type: string
    default: ""
    example: https://metrics.lecoq.io

  plugin_screenshot_selector:
-    description: CSS Selector
+    description: |
+      CSS Selector
    type: string
    default: body

  plugin_screenshot_background:
-    description: Display background
+    description: |
+      Background
    type: boolean
    default: yes
--- a/source/plugins/community/stock/metadata.yml
+++ b/source/plugins/community/stock/metadata.yml
@@ -1,6 +1,7 @@
-name: "💹 Stock prices"
+name:"💹 Stock prices
 category: community
-description: This plugin displays the stock market price of a given company.
+description: |
+  This plugin displays the stock market price of a given company.
 examples:
  default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg
 authors:
@@ -13,24 +14,30 @@ scopes: []
 inputs:

  plugin_stock:
-    description: Enable stock plugin
+    description: |
+      Enable stock plugin
    type: boolean
    default: no
+    extras:
+      - metrics.npm.optional.chartist

  plugin_stock_token:
-    description: Yahoo Finance token
+    description: |
+      Yahoo Finance token
    type: token
    default: ""

  plugin_stock_symbol:
-    description: Company stock symbol
+    description: |
+      Company stock symbol
    type: string
    default: ""
    example: MSFT

  plugin_stock_duration:
    description: |
-      Time range (relative to current date)
+      Time range
+
      - `1d`: Today
      - `5d`: 5 days
      - `1mo`: 1 month
@@ -42,6 +49,8 @@ inputs:
      - `10y`: 10 years
      - `ytd`: Year to date
      - `max`: All time
+
+      This is relative to current date
    type: string
    default: 1d
    values:
@@ -60,6 +69,7 @@ inputs:
  plugin_stock_interval:
    description: |
      Time interval between points
+
      - `1m`: 1 minute
      - `2m`: 2 minutes
      - `5m`: 5 minutes