diff --git a/README.md b/README.md index 259e7722..dd2a58aa 100644 --- a/README.md +++ b/README.md @@ -532,6 +532,13 @@ Huge thanks to the sponsors helping to support Dashy's development! Vincent Koc + + + BrianCurliss +
+ Brian Curliss + + AnandChowdhary @@ -539,13 +546,6 @@ Huge thanks to the sponsors helping to support Dashy's development! Anand Chowdhary - - - shrippen -
- Shrippen - - bile0026 @@ -560,21 +560,14 @@ Huge thanks to the sponsors helping to support Dashy's development! Ulises Gascón - - - digitalarche -
- Digital Archeology - - - InDieTasten
InDieTasten - + + araguaci @@ -589,13 +582,6 @@ Huge thanks to the sponsors helping to support Dashy's development! Brian McGonagill - - - arcestia -
- Laurensius Jeffrey - - vlad-tim @@ -609,8 +595,7 @@ Huge thanks to the sponsors helping to support Dashy's development!
HeliXZz - - + mryesiller @@ -618,20 +603,14 @@ Huge thanks to the sponsors helping to support Dashy's development! Göksel Yeşiller - - - sushibait -
- Shiverme Timbers - - undefined
Undefined - + + OlliVHH @@ -646,14 +625,6 @@ Huge thanks to the sponsors helping to support Dashy's development! Frankdez93 - - - st617 -
- St617 - - - hudsonrock-partnerships @@ -662,10 +633,10 @@ Huge thanks to the sponsors helping to support Dashy's development! - - CarterPerez-dev + + gl0bal01
- Carter Perez + Gl0bal01 💖 龴ↀ◡ↀ龴 diff --git a/docs/assets/CONTRIBUTORS.svg b/docs/assets/CONTRIBUTORS.svg index f9691569..0c24c723 100644 --- a/docs/assets/CONTRIBUTORS.svg +++ b/docs/assets/CONTRIBUTORS.svg @@ -60,14 +60,14 @@ + + + - + - - - - + @@ -75,14 +75,14 @@ - - - - + - + + + + @@ -93,89 +93,89 @@ - - - - - - - + - - - - + - + - + - + - + + + + - + + + + + + + + + + - - - - + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - + @@ -189,20 +189,20 @@ - - - - + - + - + - + + + + @@ -219,35 +219,35 @@ + + + - + - + - + - + - + - + - + - + - - - - + @@ -309,121 +309,124 @@ + + + - + - + - + - + - + - + - + - + - + + + + - + - + - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + \ No newline at end of file diff --git a/docs/configuring.md b/docs/configuring.md index c10088f0..266b98a1 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -93,7 +93,9 @@ The following file provides a reference of all supported configuration options. **Field** | **Type** | **Required**| **Description** --- | --- | --- | --- **`name`** | `string` | Required | A unique name for that page -**`path`** | `string` | Required | The path (local or remote) to the config file to use.
For files located within `/public`, you only need to specify filename, for externally hosted files you must include the full URL +**`path`** | `string` | Required | The path (local or remote) to the config file to use.
For files located within `/user-data`, you only need to specify filename, for externally hosted files you must include the full URL + +For more info, see the[Multi-Page docs](/docs/pages-and-sections.md#multi-page-support) **[⬆️ Back to Top](#configuring)** diff --git a/docs/credits.md b/docs/credits.md index a2025160..107fdf2f 100644 --- a/docs/credits.md +++ b/docs/credits.md @@ -11,6 +11,13 @@ Vincent Koc + + + BrianCurliss +
+ Brian Curliss + + AnandChowdhary @@ -18,13 +25,6 @@ Anand Chowdhary - - - shrippen -
- Null - - bile0026 @@ -39,21 +39,14 @@ Ulises Gascón - - - digitalarche -
- Digital Archeology - - - InDieTasten
Null - + + araguaci @@ -68,13 +61,6 @@ Brian McGonagill - - - arcestia -
- Laurensius Jeffrey - - vlad-tim @@ -88,8 +74,7 @@
HeliXZz - - + mryesiller @@ -97,20 +82,14 @@ Göksel Yeşiller - - - sushibait -
- Shiverme Timbers - - getumbrel
Umbrel - + + OlliVHH @@ -131,14 +110,6 @@
Terminal Trove - - - - - st617 -
- Null - @@ -148,10 +119,17 @@ - - CarterPerez-dev + + gl0bal01
- Carter Perez + Gl0bal01 💖 龴ↀ◡ↀ龴 + + + + + Quad4-Software +
+ Quad4 Software @@ -311,6 +289,13 @@ UrekD + + + zcq100 +
+ Null + + hockwill @@ -324,13 +309,6 @@
Mihai - - - - zcq100 -
- Null - @@ -347,13 +325,6 @@ Null - - - dasunsrule32 -
- Aaron Echols - - aviolaris @@ -368,6 +339,13 @@ David Alasow + + + dasunsrule32 +
+ Aaron Echols + + Totto16 @@ -390,13 +368,6 @@ Remygrandin - - - DimitriDR -
- Dimitri - - rubenandre @@ -404,27 +375,12 @@ Rúben Silva - - - alucarddelta -
- Brent - - rtm516
Rtm516 - - - - - berksmbl -
- Berk Sümbül - @@ -439,7 +395,8 @@
Stanly0726 - + + kt-alt @@ -454,14 +411,42 @@ Bogyeong Kim + + + webysther +
+ Webysther Sperandio + + jtuzar
Jakub Tuzar + + + + lucolvin +
+ Luke + + + + + berksmbl +
+ Berk Sümbül + + + + alucarddelta +
+ Brent + + BySempron @@ -469,13 +454,6 @@ Sergio - - - zigotica -
- Sergi Meseguer - - ssrangisetti @@ -483,6 +461,13 @@ Null + + + zigotica +
+ Sergi Meseguer + + rokiden @@ -496,15 +481,15 @@
Patrick Heeney - + + mmihaly
Null - - + m42cel @@ -539,15 +524,15 @@
Alessandro Del Prete - + + a-mnich
Alexander Mnich - - + BOZG @@ -582,13 +567,6 @@
GuilhermeLCS - - - - lucolvin -
- Luke - @@ -619,28 +597,21 @@ Null - - - rubjo -
- Null - - turnrye
Ryan Turner - - + sachahjkl
Sacha - + + shazzx @@ -655,6 +626,13 @@ Shawn Salat + + + sxravan +
+ Shravan Dwarka + + royshreyaa @@ -691,6 +669,13 @@ Steven Kast + + + rubjo +
+ Null + + PrynsTag @@ -711,15 +696,15 @@
OKAMOTO Shigehiro - + + bubylou
Nicholas Malcolm - - + michaelfeinbier @@ -754,13 +739,6 @@
Maxime Moreillon - - - - Glitch3dPenguin -
- Max Kulik - @@ -906,6 +884,13 @@ Thibaut + + + Glitch3dPenguin +
+ Max Kulik + + edugof @@ -926,15 +911,15 @@
Thandy Norberto - + + ddenev
Dragomir Denev - - + dougaldhub @@ -969,6 +954,14 @@
David + + + + + The127 +
+ Darkarotte + @@ -976,8 +969,7 @@
Dan - - + clsty @@ -992,13 +984,6 @@ Bumsoo Kim - - - NicholasWilsonDEV -
- Nicholas Wilson - - BhasherBEL @@ -1012,15 +997,15 @@
Begin - + + BRAVO68WEB
Jyotirmoy Bandyopadhyaya [Bravo68] - - + AaronPorts @@ -1055,15 +1040,15 @@
Markus Krause - + + asenov
Мирослав Асенов - - + luispabon @@ -1098,15 +1083,15 @@
John Horton - + + Singebob
Jeremy Chauvin - - + Hellhium @@ -1141,15 +1126,15 @@
Ian Neal - + + ip2location
IP2Location - - + FraglyG @@ -1184,7 +1169,8 @@
Fedello - + + emiran-orange diff --git a/docs/quick-start.md b/docs/quick-start.md index 6d0d550d..1176b9c8 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -42,7 +42,7 @@ Any files placed here will be served up to the root of the domain, and override For example, if you had `user-data/favicon.ico` this would be accessible at `http://my-dashy-instance.local/favicon.ico` Example Files in `user-data`: -- `conf.yml` - This is the only file that is compulsary, it's your main Dashy config +- `conf.yml` - This is the only file that is compulsory, it's your main Dashy config - `**.yml` - Include more config files, if you'd like to have multiple pages, see [Multi-page support](/docs/pages-and-sections.md#multi-page-support) for docs - `favicon.ico` - The default favicon, shown in the browser's tab title - `initialization.html` - Static HTML page displayed before the app has finished compiling, see [`public/initialization.html`](https://github.com/Lissy93/dashy/blob/master/public/initialization.html) @@ -61,7 +61,7 @@ Example Files in `user-data`: Now that you've got Dashy running, you are going to want to set it up with your own content. Config is written in [YAML Format](https://yaml.org/), and saved in [`/user-data/conf.yml`](https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml). -The format on the config file is pretty straight forward. There are three root attributes: +The format on the config file is pretty straight forward. There are four root attributes: - [`pageInfo`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pageinfo) - Dashboard meta data, like title, description, nav bar links and footer text - [`appConfig`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#appconfig-optional) - Dashboard settings, like themes, authentication, language and customization diff --git a/docs/widgets.md b/docs/widgets.md index f8eb19e0..e83f6d0f 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -707,7 +707,7 @@ Display current FX rates in your native currency. Hover over a row to view more Counting down to the next day off work? This widget displays upcoming public holidays for your country. Data is fetched from [Enrico](http://kayaposoft.com/enrico/) -Note, config for this widget is case-sensetive (see [#1268](https://github.com/Lissy93/dashy/issues/1268)) +Note, config for this widget is case-sensitive (see [#1268](https://github.com/Lissy93/dashy/issues/1268))

@@ -792,7 +792,7 @@ Or ### Sports Scores -Show recent scores and upcoming matches from your favourite sports team. Data is fetched from [TheSportsDB.com](https://www.thesportsdb.com/). From the UI, you can click any other team to view their scores and upcoming games, or click a league name to see all teams. +Show recent scores and upcoming matches from your favorite sports team. Data is fetched from [TheSportsDB.com](https://www.thesportsdb.com/). From the UI, you can click any other team to view their scores and upcoming games, or click a league name to see all teams.

@@ -2440,7 +2440,7 @@ Here an example for Docker Glances can be launched with the `glances` command. You'll need to run it in web server mode, using the `-w` option for the API to be reachable. If you don't plan on using the Web UI, then you can disable it using `--disable-webui`. See the [command reference docs](https://glances.readthedocs.io/en/latest/cmds.html) for more info. -If Glances is running on a Windows system it is recommanded to add the following arguments ```--disable-plugin all --enable-plugin cpu,mem,diskio,ip,network,containers,quicklook,load,fs,alert -w``` This is due to Glances not being that stable on windows, so disabling all plugins that aren't used by Dashy widgets can save on ressources. +If Glances is running on a Windows system it is recommended to add the following arguments ```--disable-plugin all --enable-plugin cpu,mem,diskio,ip,network,containers,quicklook,load,fs,alert -w``` This is due to Glances not being that stable on windows, so disabling all plugins that aren't used by Dashy widgets can save on ressources. #### Options