Commit graph

145 commits

Author SHA1 Message Date
David Alasow
ca8085c482 Fix various typos
Fixed some typos and capitalization errors. Fixed some more formatting.
Changed file name that contained a typo.
2022-08-23 11:22:47 +02:00
David Alasow
2d731d3ed3 Fix inconsistent markdown formatting.
This changes all of the documentation markdown files to follow
the same rules. The rules I've applied are from
https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md

The reason I felt it was necessary
to change all the files was
that there were a lot inconsistencies in how the markdown was used.
Ranging from header levels to some headers having a new line before
content and some not.
2022-08-23 09:57:02 +02:00
David Alasow
99463413b1 Fix formatting in documentation
Removed trailing whitespaces and extra newlines. Added some missing
punctuation. Replaced unicode characters that aren't commonly used
with the more common character.

The replaced unicode characters are
- ’ (U+2019) to ' (U+0027)
- “ (U+201C) to " (U+0022)
- ” (U+201D) to " (U+0022)
2022-08-22 17:52:07 +02:00
Alicia Sykes
37954eaeb0 🥅 Catches errors if caused by undefined options 2022-07-23 14:42:26 +01:00
Jammo2k5
19e312b777 Fixed image link again... 2022-07-20 22:49:10 +01:00
Jammo2k5
53e3082dc2 Changed image host of Widget Docs 2022-07-20 22:46:31 +01:00
Jammo2k5
8d22d88471 added gluetun service status widget 2022-07-20 22:08:30 +01:00
Alicia Sykes
55bde6c78a
📝 Updates link to APOD API
The previous one, PawelPleskaczynski/apod_api is no longer opperational.
I've re-written it at https://github.com/lissy93/go-apod
2022-07-17 22:41:35 +01:00
Alucarddelta
b10a88b022 Sabnzbd Widget 2022-07-10 21:36:43 +10:00
Lissy93
869a5993e8 📝 Adds docs for widget labels (#769) 2022-07-02 22:29:06 +01:00
Alicia Sykes
9235123f10 🔀 Merge branch 'master' of github.com:Lissy93/dashy into REFACTOR/widget-and-docs-improvments 2022-06-30 15:00:51 +01:00
Marcell Fülöp
2ee853d33f 📝 Add widget documentation 2022-06-20 18:49:22 +00:00
Alicia Sykes
2ef5b66e9e 🥅 Adds an option to surpress widget errors 2022-06-09 01:26:45 +01:00
Marcell Fülöp
2d6c499192 Optionally allow the widget to filter on StatPing Group and to display in a more compact view.
* Add widget option: `groupId`. StatPing services are filtered for the given group.
* Add widget options: `showChart` and `showInfo`. Initially hide the chart and info summary.
* Add buttons to show/hide chart and info sections.
* Update widget documentation.
2022-06-08 19:50:15 +00:00
Alicia Sykes
1ad89958bc 📝 Adds docs for AdGuard widgets (#493) 2022-06-04 21:12:26 +01:00
Alicia Sykes
fea51a1a75 📝 Adds docs for domain name monitor widget 2022-06-04 21:12:25 +01:00
Alicia Sykes
8c43442b39 🎨 Adds option to hide sports thumbnail (#654) 2022-05-16 21:46:19 +01:00
Alicia Sykes
4287092ea2 Option to hide seconds in Clock (#644) 2022-05-11 10:52:16 +01:00
Alicia Sykes
bcb1b70447
📝 Adds note about the system stats widget (#643)
Closed #643
2022-05-10 15:47:14 +01:00
Alicia Sykes
558690ad98
📝 Fixes docs link to Synology Download Station 2022-04-23 22:53:35 +01:00
Rémy GRANDIN
044b7ed94d 📝 Add Synology Download widget documentation 2022-04-23 02:45:46 +02:00
Alicia Sykes
4c713bfce6 Adds Mullvad and IP blacklist check widgets 2022-04-14 19:02:51 +01:00
Alicia Sykes
00709acd51
📝 Updates contents of widget docs 2022-03-31 20:49:53 +01:00
Alicia Sykes
6220f9b7f8 🗃️ Adds widget request timeout to schema and docs 2022-03-27 21:22:26 +01:00
Alicia Sykes
2e63da041a
📝 Updates widget contributing docs 2022-02-17 18:00:02 +00:00
Alicia Sykes
7b6815a318 Adds a static image widget (#487) 2022-02-13 23:24:16 +00:00
Alicia Sykes
c9283fc3be 📝 Adds example of embedding an image (#487) 2022-02-13 19:01:40 +00:00
Alicia Sykes
1626b94285 📊 Adds widget to display CPU temps (#452) 2022-02-13 15:15:04 +00:00
Alicia Sykes
730280a448 Adds Glances IP address widget (#437) 2022-01-24 13:29:08 +00:00
Alicia Sykes
edbd770a2d IP address widget used ipapi.co by default (#437) 2022-01-24 12:37:47 +00:00
Alicia Sykes
5b6e75766d Adds support for fetching IP via HTTPS (#437) 2022-01-24 12:20:16 +00:00
Alicia Sykes
eb3905bb8d 📝 Adds widget troubleshooting guide 2022-01-23 12:16:18 +00:00
Alicia Sykes
4278764101 📝 Refactors loads of docs
⚰️ Death by Documentation
2022-01-22 20:43:38 +00:00
Alicia Sykes
58a085a550 Adds an email widget for AnonAddy 2022-01-21 12:58:15 +00:00
Alicia Sykes
7b7c427c97 📝 Reorders widget docs 2022-01-20 05:12:33 +00:00
Alicia Sykes
dfea4e317c Refactors all Glances widgets to inherit from parent mixin 2022-01-19 11:43:04 +00:00
Alicia Sykes
b3dcc5e43f 🍱 Adds screenshot to widget docs 2022-01-18 23:59:41 +00:00
Alicia Sykes
88727cf2e2 Adds a network traffic widget 2022-01-18 23:07:24 +00:00
Alicia Sykes
6d9e34c90f Adds a network interface widget 2022-01-18 19:11:03 +00:00
Alicia Sykes
6b8a5ee086 Adds a system alert widget 2022-01-18 17:16:00 +00:00
Alicia Sykes
9148195b84 Built system load and load history widgets 2022-01-18 16:03:44 +00:00
Alicia Sykes
63a0d18813 Adds a disk IO widget 2022-01-15 21:30:43 +00:00
Alicia Sykes
3a3364f156 Adds file system widget 2022-01-08 17:06:36 +00:00
Alicia Sykes
e3b3f3c5a8 Adds current memory history widget 2022-01-08 14:10:04 +00:00
Alicia Sykes
4e64ccff3b Adds current memory usage widget 2022-01-08 13:55:26 +00:00
Alicia Sykes
8349206770 Adds CPU history widget 2022-01-08 13:32:43 +00:00
Alicia Sykes
f5c11b3dc6 Adds Covid status widget 2022-01-03 18:31:49 +00:00
Alicia Sykes
710b3ea7ad Adds crypto wallet balance widget 2022-01-03 12:32:00 +00:00
Alicia Sykes
d516bb02fa 💬 Adds option for clock to have customCityName (#402) 2022-01-03 09:39:51 +00:00
Alicia Sykes
7b030d8e5b Adds current Eth gas price widget 2022-01-02 23:09:31 +00:00
Kieren Connell
59694c57cc
Update widgets.md
Remove API key under Widget Usage Guide for weather widget and replace with xx's
2022-01-01 16:16:28 +00:00
Alicia Sykes
7f968a708a 📝 Adds docs on proxying requests 2021-12-30 21:21:06 +00:00
Alicia Sykes
c650743384 💄 Shows country flag in exchange rate widget 2021-12-29 14:30:36 +00:00
Alicia Sykes
5684bf06e8 Adds a Sports Scores widget 2021-12-29 12:49:57 +00:00
Alicia Sykes
e628650dd1 📝 Adds widget docs to readme 2021-12-27 22:22:49 +00:00
Alicia Sykes
3ffdf753cc 📝 Adds privacy info for each widget in docs 2021-12-27 17:16:42 +00:00
Alicie
1296ca0bda Adds widget for monitoring CVE vulnerabilities 2021-12-27 00:07:52 +00:00
Alicia Sykes
6c0fb6fd41 📝 Adds docs about global widget UI options 2021-12-26 00:31:46 +00:00
Alicia Sykes
c591a03f66 Adds option to specify height of frame widget 2021-12-25 23:21:31 +00:00
Alicia Sykes
0074c636b6 🚧 Commiting to switch computers... 2021-12-23 08:58:52 +00:00
Alicia Sykes
ff6fb33d00 📝 Updates widget docs 2021-12-19 23:31:41 +00:00
Alicia Sykes
901c873d4e Adds a StatPing widget 2021-12-19 23:07:50 +00:00
Alicia Sykes
8ae310ebd3 Adds a cron job monitoring widget 2021-12-19 20:05:56 +00:00
Alicia Sykes
8686a99be7 Adds a news headlines widget 2021-12-19 01:55:46 +00:00
Alicia Sykes
9cbf08678b Adds a widget that pi-hole shows traffic graph 2021-12-18 21:31:31 +00:00
Alicia Sykes
79c55af986 Adds a Pi-Hole top queries widget 2021-12-18 21:02:31 +00:00
Alicia Sykes
dece5c58aa Adds a Pi-Hole stats widget 2021-12-18 20:12:13 +00:00
Alicia Sykes
fad1e5ff50 Adds NASA APOD widget 2021-12-18 14:57:24 +00:00
Alicia Sykes
7084ca12d0 Adds widget to show trending GitHub repos 2021-12-18 14:06:48 +00:00
Alicia Sykes
24cf0d1e0d Adds GitHub profile stats widget 2021-12-17 21:37:57 +00:00
Alicia Sykes
08de6b8f17 Adds widget for showing public IP 2021-12-17 20:16:11 +00:00
Alicia Sykes
be5188ef7d Adds upcoming public holidays widget 2021-12-17 16:52:12 +00:00
Alicia Sykes
b7cd2d4c06 Builds a widget for CodeStats 2021-12-16 23:33:27 +00:00
Alicia Sykes
e0b09d48ee Adds widget to fetch and display system stats 2021-12-16 04:03:36 +00:00
Alicia Sykes
6e84dacd51 Builds system memory monitoring widget 2021-12-16 00:50:21 +00:00
Alicia Sykes
f1bc2a2888 Builds system load usage widget 2021-12-15 02:28:48 +00:00
Alicia Sykes
283d8c750e Builds CPU history widget 2021-12-15 02:17:17 +00:00
Alicia Sykes
66067b002f 🔥 Deletes ExampleWidget, adds tutorial for creating widget 2021-12-14 20:31:00 +00:00
Alicia Sykes
3da76ce299 👻 A simple example widget
A simple example which you can use as a template for creating your own widget. Takes two optional parameters (text and count), and fetches a list of images from dummyapis.com, and renders the results to the UI.
2021-12-14 19:02:45 +00:00
Alicia Sykes
6df95c9387 Made an RSS feed widget 2021-12-14 16:58:29 +00:00
Alicia Sykes
f61366ca48 Builds a content embed widget 2021-12-14 13:48:50 +00:00
Alicia Sykes
642cfc655b Builds live flight data widget 2021-12-14 00:55:01 +00:00
Alicia Sykes
ae8179ecd7 Creates an embedable webpage widget 2021-12-13 14:03:39 +00:00
Alicia Sykes
d9759c06b3 Creates a joke-fetching widget 2021-12-12 19:06:32 +00:00
Alicia Sykes
51b7e639cc Creates an stock price chart widget 2021-12-12 16:30:07 +00:00
Alicia Sykes
a77cb9430f Creates an FX widget 2021-12-12 15:04:34 +00:00
Alicia Sykes
464eef9338 📝 Adds screenshots to widget docs 2021-12-11 22:36:43 +00:00
Alicia Sykes
f6e11921ef Adds XKCD comic widget 2021-12-11 22:31:16 +00:00
Alicia Sykes
9d21fa48d0 Adds XKCD comic widget 2021-12-11 22:29:52 +00:00
Alicia Sykes
985b0000fa Adds a crypto price watch-list widget 2021-12-11 21:11:07 +00:00
Alicia Sykes
ebd4c48300 Develops a crypto price chart widget 2021-12-11 18:50:11 +00:00
Alicia Sykes
cf7e021a82 Adds a London Underground status widget 2021-12-10 13:17:48 +00:00
Alicia Sykes
c38a094a63 Adds a weather forecast widget 2021-12-08 19:58:03 +00:00
Alicia Sykes
f6686d99ad 📝 Adds docs for the weather widget 2021-12-03 16:54:11 +00:00
Alicia Sykes
080e68445c Made a simple clock widget 2021-11-28 21:27:30 +00:00