π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
Small docs updates
Alicia Sykesf3bee653a09c
diff --git a/README.md b/README.mdindex 7f760ea3..a6746eee 100644--- a/README.md+++ b/README.md@@ -299,6 +299,13 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWAREOR THEOR OTHER DEALINGS IN THE SOFTWARE.```+#### Author π¦+<p align="right"><img width="200" src="https://i.ibb.co/FnxqTfx/aht-bot-round.png" alt="Alicia Sykes"></p>+Developed by [Alicia Sykes](https://aliciasykes.com) ([@Lissy93](https://github.com/lissy93)) in 2021.++- **PGP Key**: [`0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7`](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7)+- **BTC Address**: `3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC`+**[β¬οΈ Back to Top](#dashy)**---diff --git a/docs/configuring.md b/docs/configuring.mdindex acae2cae..938f52c0 100644--- a/docs/configuring.md+++ b/docs/configuring.md@@ -50,6 +50,8 @@ All fields are optional, unless otherwise stated.**`backgroundImg`** | `string` | _Optional_ | Path to an optional full-screen app background image. This can be either remote (http) or local (/). Note that this will slow down initial load**`enableFontAwesome`** | `boolean` | _Optional_ | Where `true` is enabled, if left blank font-awesome will be enabled only if required by 1 or more icons**`fontAwesomeKey`** | `string` | _Optional_ | If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. `13014ae648`)+**`layout`** | `string` | _Optional_ | App layout, either `horizontal`, `vertical`, `auto` or `sidebar`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified from the UI.+**`iconSize`** | `string` | _Optional_ | The size of link items / icons. Can be either `small`, `medium,` or `large`. Defaults to `medium`. This can also be set directly from the UI.**`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI)**`cssThemes`** | `string[]` | _Optional_ | An array of custom theme names which can be used in the theme switcher dropdown**`externalStyleSheet`** | `string` or `string[]` | _Optional_ | Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI@@ -104,9 +106,9 @@ All fields are optional, unless otherwise stated.**`itemSize`** | `string` | _Optional_ | Specify the size for items within this group, either `small`, `medium` or `large`. Note that this will overide any settings specified through the UI**`rows`** | `number` | _Optional_ | Height of the section, specified as the number of rows it should span vertically, e.g. `2`. Defaults to `1`. Max is `5`.**`cols`** | `number` | _Optional_ | Width of the section, specified as the number of columns the section should span horizontally, e.g. `2`. Defaults to `1`. Max is `5`.-**`layout`** | `string` | _Optional_ | Specify which CSS layout will be used to responsivley place items. Can be either `auto` (which uses flex layout), or `grid`. If `grid` is selected, then `itemCountX` and `itemCountY` may also be set. Defaults to `auto`-**`itemCountX`** | `number` | _Optional_ | The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if `layout` is set to `grid`. Must be a whole number between `1` and `12`-**`itemCountY`** | `number` | _Optional_ | The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If `itemCountX` is set, then `itemCountY` can be calculated automatically. Can only be set if `layout` is set to `grid`. Must be a whole number between `1` and `12`+**`sectionLayout`** | `string` | _Optional_ | Specify which CSS layout will be used to responsivley place items. Can be either `auto` (which uses flex layout), or `grid`. If `grid` is selected, then `itemCountX` and `itemCountY` may also be set. Defaults to `auto`+**`itemCountX`** | `number` | _Optional_ | The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`+**`itemCountY`** | `number` | _Optional_ | The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If `itemCountX` is set, then `itemCountY` can be calculated automatically. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`**[β¬οΈ Back to Top](#configuring)**diff --git a/docs/contributing.md b/docs/contributing.mdindex 7d225eb7..d5dbf358 100644--- a/docs/contributing.md+++ b/docs/contributing.md@@ -128,7 +128,8 @@ Click one of the links below, to open an issue:### Contributors-++### Star-Gazers Over Timediff --git a/docs/readme.md b/docs/readme.mdindex 97d43511..3eed3712 100644--- a/docs/readme.md+++ b/docs/readme.md@@ -7,5 +7,6 @@- [User Guide](/docs/user-guide.md)- [Troubleshooting](/docs/troubleshooting.md)- [Backup & Restore](/docs/backup-restore.md)+- [Status Indicators](/docs/status-indicators.md)- [Theming](/docs/theming.md)- [Authentication](/docs/authentication.md)diff --git a/docs/theming.md b/docs/theming.mdindex 02ea6a86..5a90180a 100644--- a/docs/theming.md+++ b/docs/theming.md@@ -114,6 +114,8 @@ You can target specific elements on the UI with these variables. All are optiona- `--toast-color` - Text, icon and border color in the toast info popup. Defaults to `--background`- `--welcome-popup-background` - Background for the info pop-up shown on first load. Defaults to `--background-darker`- `--welcome-popup-text-color` - Text color for the welcome pop-up. Defaults to `--primary`+- `--side-bar-background` - Background color of the sidebar used in the workspace view. Defaults to `--background-darker`+- `--side-bar-color` - Color of icons and text within the sidebar. Defaults to `--primary`#### Non-Color Variables- `--outline-color` - Used to outline focused or selected elements