josh/dashy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates the docs

Browse Source
This commit is contained in:
Alicia Sykes
2021-06-12 16:26:18 +01:00
parent 7b9fd97433
commit 9e9a1c7fe7
4 changed files with 215 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/configuring.md
View File

@@ -13,7 +13,6 @@ There's a couple of things to remember, before getting started:
All fields are optional, unless otherwise stated.
#### Top-Level Fields
**Field** | **Type** | **Required**| **Description**
@@ -22,6 +21,8 @@ All fields are optional, unless otherwise stated.
**`appConfig`** | `object` | _Optional_ | Settings related to how the app functions, including API keys and global styles. See [`appConfig`](#appconfig-optional)
**`sections`** | `array` | Required | An array of sections, each containing an array of items, which will be displayed as links. See [`section`](#section)
**[⬆️ Back to Top](#configuring)**
#### `PageInfo`
**Field** | **Type** | **Required**| **Description**
@@ -31,6 +32,8 @@ All fields are optional, unless otherwise stated.
**`navLinks`** | `array` | _Optional_ | Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See [`navLinks`](#pageinfonavlinks-optional)
**`footerText`** | `string` | _Optional_ | Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS
**[⬆️ Back to Top](#configuring)**
#### `pageInfo.navLinks` _(optional)_
**Field** | **Type** | **Required**| **Description**
@@ -38,6 +41,8 @@ All fields are optional, unless otherwise stated.
**`title`** | `string` | Required | The text to display on the link button
**`path`** | `string` | Required | The URL to navigate to when clicked. Can be relative (e.g. `/about`) or absolute (e.g. `https://example.com` or `http://192.168.1.1`)
**[⬆️ Back to Top](#configuring)**
#### `appConfig` _(optional)_
**Field** | **Type** | **Required**| **Description**
@@ -51,6 +56,8 @@ All fields are optional, unless otherwise stated.
**`customCss`** | `string` | _Optional_ | Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first.
**`showSplashScreen`** | `boolean` | _Optional_ | Should display a splash screen while the app is loading. Defaults to false, except on first load
**[⬆️ Back to Top](#configuring)**
#### `section`
**Field** | **Type** | **Required**| **Description**
@@ -60,6 +67,8 @@ All fields are optional, unless otherwise stated.
**`items`** | `array` | Required | An array of items to be displayed within the section. See [`item`](#sectionitem)
**`displayData`** | `object` | _Optional_ | Meta-data to optionally overide display settings for a given section. See [`displayData`](#sectiondisplaydata-optional)
**[⬆️ Back to Top](#configuring)**
#### `section.item`
**Field** | **Type** | **Required**| **Description**
@@ -72,6 +81,8 @@ All fields are optional, unless otherwise stated.
**`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well
**`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background
**[⬆️ Back to Top](#configuring)**
#### `section.displayData` _(optional)_
**Field** | **Type** | **Required**| **Description**
@@ -86,12 +97,15 @@ All fields are optional, unless otherwise stated.
**`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`
**[⬆️ Back to Top](#configuring)**
#### `section.icon` and `section.item.icon`
**Field** | **Type** | **Required**| **Description**
--- | --- | --- | ---
**`icon`** | `string` | _Optional_ | The icon for a given item or section. Can be a font-awesome icon, favicon, remote URL or local URL. If set to `favicon`, the icon will be automatically fetched from the items website URL. To use font-awesome, specify the category, followed by the icon name, e.g. `fas fa-rocket`, `fab fa-monero` or `fal fa-duck` - note that to use pro icons, you mut specify `appConfig.fontAwesomeKey`. You can also use hosted any by specifying it's URL, e.g. `https://i.ibb.co/710B3Yc/space-invader-x256.png`. To use a local image, first store it in `./public/item-icons/` (or `-v /app/public/item-icons/` in Docker) , and reference it by name and extension - e.g. set `image.png` to use `./public/item-icon/image.png`, you can also use sub-folders if you have a lot of icons, to keep them organised.
**[⬆️ Back to Top](#configuring)**
#### Example
@@ -125,3 +139,6 @@ sections: # An array of sections
```
For more example config files, see: [this gist](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
**[⬆️ Back to Top](#configuring)**