✨ Adds XKCD comic widget

2021-12-11 22:29:52 +00:00
parent 985b0000fa
commit 9d21fa48d0
4 changed files with 106 additions and 0 deletions
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -140,6 +140,26 @@ Shows recent price history for a given crypto asset, using price data fetched fr
    numDays: 7
 ```

+### XKCD Comics
+
+Have a laugh with the daily comic from [XKCD](https://xkcd.com/). A classic webcomic website covering everything from Linux, math, romance, science and language.
+
+##### Options
+
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`comic`** | `string | number` |  _Optional_ | Choose which comic to display. Set to either `random`, `latest` or the series number of a specific comic, like `627`. Defaults to `latest`
+
+##### Example
+
+```yaml
+- name: XKCD of the Day
+  icon: fas fa-laugh
+  type: xkcd-comic
+  options:
+    comic: latest
+```
+
 ### TFL Status

 Shows real-time tube status of the London Underground. All options are optional.