tyler.durden
/
dashy
mirror of https://github.com/Lissy93/dashy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds auto-generated docs for config schema

This commit is contained in:
Alicia Sykes 2021-06-07 00:43:04 +01:00
parent bc1a53cd1e
commit f19eac342e
43 changed files with 1630 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/config-schema/README.md Normal file
View File

@ -0,0 +1,35 @@
# README
## Top-level Schemas
* [Dashy Config Schema](./dashy-config.md) – `https://example.com/schemas/abstract`
## Other Schemas
### Objects
* [Untitled object in Dashy Config Schema](./dashy-config-properties-pageinfo.md) – `https://example.com/schemas/abstract#/properties/pageInfo`
* [Untitled object in Dashy Config Schema](./dashy-config-properties-pageinfo-properties-navlinks-items.md) – `https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items`
* [Untitled object in Dashy Config Schema](./dashy-config-properties-appconfig.md "Application configuration") – `https://example.com/schemas/abstract#/properties/appConfig`
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items.md) – `https://example.com/schemas/abstract#/properties/sections/items`
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items-properties-displaydata.md "Optional meta data for customizing a section") – `https://example.com/schemas/abstract#/properties/sections/items/properties/displayData`
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items-properties-items-items.md) – `https://example.com/schemas/abstract#/properties/sections/items/properties/items/items`
### Arrays
* [Untitled array in Dashy Config Schema](./dashy-config-properties-pageinfo-properties-navlinks.md "Quick access links, displayed in header") – `https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks`
* [Untitled array in Dashy Config Schema](./dashy-config-properties-appconfig-properties-cssthemes.md "Theme names to be added to the dropdown") – `https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes`
* [Untitled array in Dashy Config Schema](./dashy-config-properties-sections.md "Array of sections, containing items") – `https://example.com/schemas/abstract#/properties/sections`
* [Untitled array in Dashy Config Schema](./dashy-config-properties-sections-items-properties-items.md "Array of items to display with a section") – `https://example.com/schemas/abstract#/properties/sections/items/properties/items`
## Version Note
The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-06/schema#`

15
docs/config-schema/dashy-config-properties-appconfig-properties-backgroundimg.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/backgroundImg
```
A URL to an image asset to be displayed as background
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## backgroundImg Type
`string`

15
docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes-items.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes/items
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`string`

15
docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled array in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes
```
Theme names to be added to the dropdown
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## cssThemes Type
`string[]`

15
docs/config-schema/dashy-config-properties-appconfig-properties-customcss.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/customCss
```
Any custom CSS overides, must be minified
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## customCss Type
`string`

23
docs/config-schema/dashy-config-properties-appconfig-properties-enablefontawesome.md Normal file
View File

@ -0,0 +1,23 @@
# Untitled boolean in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/enableFontAwesome
```
Should load font-awesome assets
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## enableFontAwesome Type
`boolean`
## enableFontAwesome Default Value
The default value is:
```json
true
```

15
docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet-items.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet/items
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`string`

15
docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled undefined type in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet
```
URL or URLs of external stylesheets to add to dropdown/ load
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## externalStyleSheet Type
any of the folllowing: `string` or `array` ([Details](dashy-config-properties-appconfig-properties-externalstylesheet.md))

25
docs/config-schema/dashy-config-properties-appconfig-properties-fontawesomekey.md Normal file
View File

@ -0,0 +1,25 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/fontAwesomeKey
```
API key for font-awesome
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## fontAwesomeKey Type
`string`
## fontAwesomeKey Constraints
**pattern**: the string must match the following regular expression:
```regexp
^[a-z0-9]{10}$
```
[try pattern](https://regexr.com/?expression=%5E%5Ba-z0-9%5D%7B10%7D%24 "try regular expression with regexr.com")

23
docs/config-schema/dashy-config-properties-appconfig-properties-theme.md Normal file
View File

@ -0,0 +1,23 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig/properties/theme
```
A theme to be applied by default on first load
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## theme Type
`string`
## theme Default Value
The default value is:
```json
"Callisto"
```

179
docs/config-schema/dashy-config-properties-appconfig.md Normal file
View File

@ -0,0 +1,179 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/appConfig
```
Application configuration
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## appConfig Type
`object` ([Details](dashy-config-properties-appconfig.md))
# appConfig Properties
| Property | Type | Required | Nullable | Defined by |
| :---------------------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [backgroundImg](#backgroundimg) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-backgroundimg.md "https://example.com/schemas/abstract#/properties/appConfig/properties/backgroundImg") |
| [theme](#theme) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-theme.md "https://example.com/schemas/abstract#/properties/appConfig/properties/theme") |
| [enableFontAwesome](#enablefontawesome) | `boolean` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-enablefontawesome.md "https://example.com/schemas/abstract#/properties/appConfig/properties/enableFontAwesome") |
| [fontAwesomeKey](#fontawesomekey) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-fontawesomekey.md "https://example.com/schemas/abstract#/properties/appConfig/properties/fontAwesomeKey") |
| [cssThemes](#cssthemes) | `array` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-cssthemes.md "https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes") |
| [externalStyleSheet](#externalstylesheet) | Multiple | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-externalstylesheet.md "https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet") |
| [customCss](#customcss) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig-properties-customcss.md "https://example.com/schemas/abstract#/properties/appConfig/properties/customCss") |
## backgroundImg
A URL to an image asset to be displayed as background
`backgroundImg`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-backgroundimg.md "https://example.com/schemas/abstract#/properties/appConfig/properties/backgroundImg")
### backgroundImg Type
`string`
## theme
A theme to be applied by default on first load
`theme`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-theme.md "https://example.com/schemas/abstract#/properties/appConfig/properties/theme")
### theme Type
`string`
### theme Default Value
The default value is:
```json
"Callisto"
```
## enableFontAwesome
Should load font-awesome assets
`enableFontAwesome`
* is optional
* Type: `boolean`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-enablefontawesome.md "https://example.com/schemas/abstract#/properties/appConfig/properties/enableFontAwesome")
### enableFontAwesome Type
`boolean`
### enableFontAwesome Default Value
The default value is:
```json
true
```
## fontAwesomeKey
API key for font-awesome
`fontAwesomeKey`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-fontawesomekey.md "https://example.com/schemas/abstract#/properties/appConfig/properties/fontAwesomeKey")
### fontAwesomeKey Type
`string`
### fontAwesomeKey Constraints
**pattern**: the string must match the following regular expression:
```regexp
^[a-z0-9]{10}$
```
[try pattern](https://regexr.com/?expression=%5E%5Ba-z0-9%5D%7B10%7D%24 "try regular expression with regexr.com")
## cssThemes
Theme names to be added to the dropdown
`cssThemes`
* is optional
* Type: `string[]`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-cssthemes.md "https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes")
### cssThemes Type
`string[]`
## externalStyleSheet
URL or URLs of external stylesheets to add to dropdown/ load
`externalStyleSheet`
* is optional
* Type: any of the folllowing: `string` or `array` ([Details](dashy-config-properties-appconfig-properties-externalstylesheet.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-externalstylesheet.md "https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet")
### externalStyleSheet Type
any of the folllowing: `string` or `array` ([Details](dashy-config-properties-appconfig-properties-externalstylesheet.md))
## customCss
Any custom CSS overides, must be minified
`customCss`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig-properties-customcss.md "https://example.com/schemas/abstract#/properties/appConfig/properties/customCss")
### customCss Type
`string`

15
docs/config-schema/dashy-config-properties-pageinfo-properties-description.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/description
```
Sub-title, displayed in header
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## description Type
`string`

15
docs/config-schema/dashy-config-properties-pageinfo-properties-footertext.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/footerText
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## footerText Type
`string`

15
docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/path
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## path Type
`string`

15
docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/title
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## title Type
`string`

58
docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items.md Normal file
View File

@ -0,0 +1,58 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`object` ([Details](dashy-config-properties-pageinfo-properties-navlinks-items.md))
# items Properties
| Property | Type | Required | Nullable | Defined by |
| :-------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [title](#title) | `string` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/title") |
| [path](#path) | `string` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/path") |
## title
`title`
* is required
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/title")
### title Type
`string`
## path
`path`
* is required
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items/properties/path")
### path Type
`string`

19
docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks.md Normal file
View File

@ -0,0 +1,19 @@
# Untitled array in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks
```
Quick access links, displayed in header
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## navLinks Type
`object[]` ([Details](dashy-config-properties-pageinfo-properties-navlinks-items.md))
## navLinks Constraints
**maximum number of items**: the maximum number of items for this array is: `6`

15
docs/config-schema/dashy-config-properties-pageinfo-properties-title.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo/properties/title
```
Title and heading for the app
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## title Type
`string`

100
docs/config-schema/dashy-config-properties-pageinfo.md Normal file
View File

@ -0,0 +1,100 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/pageInfo
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## pageInfo Type
`object` ([Details](dashy-config-properties-pageinfo.md))
# pageInfo Properties
| Property | Type | Required | Nullable | Defined by |
| :-------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [title](#title) | `string` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-title.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/title") |
| [description](#description) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-description.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/description") |
| [navLinks](#navlinks) | `array` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks") |
| [footerText](#footertext) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo-properties-footertext.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/footerText") |
## title
Title and heading for the app
`title`
* is required
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-title.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/title")
### title Type
`string`
## description
Sub-title, displayed in header
`description`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-description.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/description")
### description Type
`string`
## navLinks
Quick access links, displayed in header
`navLinks`
* is optional
* Type: `object[]` ([Details](dashy-config-properties-pageinfo-properties-navlinks-items.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-navlinks.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks")
### navLinks Type
`object[]` ([Details](dashy-config-properties-pageinfo-properties-navlinks-items.md))
### navLinks Constraints
**maximum number of items**: the maximum number of items for this array is: `6`
## footerText
`footerText`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo-properties-footertext.md "https://example.com/schemas/abstract#/properties/pageInfo/properties/footerText")
### footerText Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled boolean in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/collapsed
```
If true, section needs to be clicked to open
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## collapsed Type
`boolean`

15
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-color.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/color
```
Hex code, or HTML color for section fill
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## color Type
`string`

29
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-cols.md Normal file
View File

@ -0,0 +1,29 @@
# Untitled number in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/cols
```
The amount of space that the section spans horizontally
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## cols Type
`number`
## cols Constraints
**maximum**: the value of this number must smaller than or equal to: `5`
**minimum**: the value of this number must greater than or equal to: `1`
## cols Default Value
The default value is:
```json
1
```

15
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/customStyles
```
CSS overides for section container
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## customStyles Type
`string`

21
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md Normal file
View File

@ -0,0 +1,21 @@
# Untitled number in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountX
```
Number of items per column
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## itemCountX Type
`number`
## itemCountX Constraints
**maximum**: the value of this number must smaller than or equal to: `12`
**minimum**: the value of this number must greater than or equal to: `1`

21
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md Normal file
View File

@ -0,0 +1,21 @@
# Untitled number in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountY
```
Number of items per row
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## itemCountY Type
`number`
## itemCountY Constraints
**maximum**: the value of this number must smaller than or equal to: `12`
**minimum**: the value of this number must greater than or equal to: `1`

33
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md Normal file
View File

@ -0,0 +1,33 @@
# Untitled undefined type in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemSize
```
Size of items within the section
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## itemSize Type
unknown
## itemSize Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :--------- | :---------- |
| `"small"` | |
| `"medium"` | |
| `"large"` | |
## itemSize Default Value
The default value is:
```json
"medium"
```

32
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-layout.md Normal file
View File

@ -0,0 +1,32 @@
# Untitled undefined type in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/layout
```
If set to grid, items have uniform width, and itemCount can be set
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## layout Type
unknown
## layout Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :------- | :---------- |
| `"grid"` | |
| `"auto"` | |
## layout Default Value
The default value is:
```json
"auto"
```

29
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-rows.md Normal file
View File

@ -0,0 +1,29 @@
# Untitled number in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/rows
```
The amount of space that the section spans vertically
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## rows Type
`number`
## rows Constraints
**maximum**: the value of this number must smaller than or equal to: `5`
**minimum**: the value of this number must greater than or equal to: `1`
## rows Default Value
The default value is:
```json
1
```

266
docs/config-schema/dashy-config-properties-sections-items-properties-displaydata.md Normal file
View File

@ -0,0 +1,266 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData
```
Optional meta data for customizing a section
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## displayData Type
`object` ([Details](dashy-config-properties-sections-items-properties-displaydata.md))
# displayData Properties
| Property | Type | Required | Nullable | Defined by |
| :---------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [collapsed](#collapsed) | `boolean` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/collapsed") |
| [color](#color) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-color.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/color") |
| [customStyles](#customstyles) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/customStyles") |
| [itemSize](#itemsize) | Not specified | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemSize") |
| [rows](#rows) | `number` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-rows.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/rows") |
| [cols](#cols) | `number` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-cols.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/cols") |
| [layout](#layout) | Not specified | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-layout.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/layout") |
| [itemCountX](#itemcountx) | `number` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountX") |
| [itemCountY](#itemcounty) | `number` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountY") |
## collapsed
If true, section needs to be clicked to open
`collapsed`
* is optional
* Type: `boolean`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/collapsed")
### collapsed Type
`boolean`
## color
Hex code, or HTML color for section fill
`color`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-color.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/color")
### color Type
`string`
## customStyles
CSS overides for section container
`customStyles`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/customStyles")
### customStyles Type
`string`
## itemSize
Size of items within the section
`itemSize`
* is optional
* Type: unknown
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemSize")
### itemSize Type
unknown
### itemSize Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :--------- | :---------- |
| `"small"` | |
| `"medium"` | |
| `"large"` | |
### itemSize Default Value
The default value is:
```json
"medium"
```
## rows
The amount of space that the section spans vertically
`rows`
* is optional
* Type: `number`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-rows.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/rows")
### rows Type
`number`
### rows Constraints
**maximum**: the value of this number must smaller than or equal to: `5`
**minimum**: the value of this number must greater than or equal to: `1`
### rows Default Value
The default value is:
```json
1
```
## cols
The amount of space that the section spans horizontally
`cols`
* is optional
* Type: `number`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-cols.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/cols")
### cols Type
`number`
### cols Constraints
**maximum**: the value of this number must smaller than or equal to: `5`
**minimum**: the value of this number must greater than or equal to: `1`
### cols Default Value
The default value is:
```json
1
```
## layout
If set to grid, items have uniform width, and itemCount can be set
`layout`
* is optional
* Type: unknown
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-layout.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/layout")
### layout Type
unknown
### layout Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :------- | :---------- |
| `"grid"` | |
| `"auto"` | |
### layout Default Value
The default value is:
```json
"auto"
```
## itemCountX
Number of items per column
`itemCountX`
* is optional
* Type: `number`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountX")
### itemCountX Type
`number`
### itemCountX Constraints
**maximum**: the value of this number must smaller than or equal to: `12`
**minimum**: the value of this number must greater than or equal to: `1`
## itemCountY
Number of items per row
`itemCountY`
* is optional
* Type: `number`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData/properties/itemCountY")
### itemCountY Type
`number`
### itemCountY Constraints
**maximum**: the value of this number must smaller than or equal to: `12`
**minimum**: the value of this number must greater than or equal to: `1`

15
docs/config-schema/dashy-config-properties-sections-items-properties-icon.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/icon
```
Icon will be displayed next to title
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## icon Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-color.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/color
```
A custom fill color of the item
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## color Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-description.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/description
```
Short description, shown on hover or in a tooltip
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## description Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-icon.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/icon
```
An icon, either as a font-awesome identifier, local or remote URL, or auto-fetched favicon
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## icon Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-provider.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/provider
```
Provider name, e.g. Microsoft
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## provider Type
`string`

33
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-target.md Normal file
View File

@ -0,0 +1,33 @@
# Untitled undefined type in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/target
```
Opening method, when item is clicked
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## target Type
unknown
## target Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :---------- | :---------- |
| `"newtab"` | |
| `"sametab"` | |
| `"iframe"` | |
## target Default Value
The default value is:
```json
"newtab"
```

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-title.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/title
```
Text shown on the item
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## title Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-url.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/url
```
The destination to navigate to when item is clicked
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## url Type
`string`

171
docs/config-schema/dashy-config-properties-sections-items-properties-items-items.md Normal file
View File

@ -0,0 +1,171 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items/items
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`object` ([Details](dashy-config-properties-sections-items-properties-items-items.md))
# items Properties
| Property | Type | Required | Nullable | Defined by |
| :-------------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [title](#title) | `string` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-title.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/title") |
| [description](#description) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-description.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/description") |
| [icon](#icon) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-icon.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/icon") |
| [url](#url) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-url.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/url") |
| [target](#target) | Not specified | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-target.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/target") |
| [color](#color) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-color.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/color") |
| [provider](#provider) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-provider.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/provider") |
## title
Text shown on the item
`title`
* is required
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-title.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/title")
### title Type
`string`
## description
Short description, shown on hover or in a tooltip
`description`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-description.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/description")
### description Type
`string`
## icon
An icon, either as a font-awesome identifier, local or remote URL, or auto-fetched favicon
`icon`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-icon.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/icon")
### icon Type
`string`
## url
The destination to navigate to when item is clicked
`url`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-url.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/url")
### url Type
`string`
## target
Opening method, when item is clicked
`target`
* is optional
* Type: unknown
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-target.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/target")
### target Type
unknown
### target Constraints
**enum**: the value of this property must be equal to one of the following values:
| Value | Explanation |
| :---------- | :---------- |
| `"newtab"` | |
| `"sametab"` | |
| `"iframe"` | |
### target Default Value
The default value is:
```json
"newtab"
```
## color
A custom fill color of the item
`color`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-color.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/color")
### color Type
`string`
## provider
Provider name, e.g. Microsoft
`provider`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items-items-properties-provider.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items/items/properties/provider")
### provider Type
`string`

15
docs/config-schema/dashy-config-properties-sections-items-properties-items.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled array in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/items
```
Array of items to display with a section
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`object[]` ([Details](dashy-config-properties-sections-items-properties-items-items.md))

15
docs/config-schema/dashy-config-properties-sections-items-properties-name.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled string in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items/properties/name
```
Title/ heading for a section
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## name Type
`string`

96
docs/config-schema/dashy-config-properties-sections-items.md Normal file
View File

@ -0,0 +1,96 @@
# Untitled object in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections/items
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## items Type
`object` ([Details](dashy-config-properties-sections-items.md))
# items Properties
| Property | Type | Required | Nullable | Defined by |
| :-------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [name](#name) | `string` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-name.md "https://example.com/schemas/abstract#/properties/sections/items/properties/name") |
| [icon](#icon) | `string` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-icon.md "https://example.com/schemas/abstract#/properties/sections/items/properties/icon") |
| [displayData](#displaydata) | `object` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData") |
| [items](#items) | `array` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-sections-items-properties-items.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items") |
## name
Title/ heading for a section
`name`
* is required
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-name.md "https://example.com/schemas/abstract#/properties/sections/items/properties/name")
### name Type
`string`
## icon
Icon will be displayed next to title
`icon`
* is optional
* Type: `string`
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-icon.md "https://example.com/schemas/abstract#/properties/sections/items/properties/icon")
### icon Type
`string`
## displayData
Optional meta data for customizing a section
`displayData`
* is optional
* Type: `object` ([Details](dashy-config-properties-sections-items-properties-displaydata.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-displaydata.md "https://example.com/schemas/abstract#/properties/sections/items/properties/displayData")
### displayData Type
`object` ([Details](dashy-config-properties-sections-items-properties-displaydata.md))
## items
Array of items to display with a section
`items`
* is required
* Type: `object[]` ([Details](dashy-config-properties-sections-items-properties-items-items.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections-items-properties-items.md "https://example.com/schemas/abstract#/properties/sections/items/properties/items")
### items Type
`object[]` ([Details](dashy-config-properties-sections-items-properties-items-items.md))

15
docs/config-schema/dashy-config-properties-sections.md Normal file
View File

@ -0,0 +1,15 @@
# Untitled array in Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract#/properties/sections
```
Array of sections, containing items
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
## sections Type
`object[]` ([Details](dashy-config-properties-sections-items.md))

77
docs/config-schema/dashy-config.md Normal file
View File

@ -0,0 +1,77 @@
# Dashy Config Schema Schema
```txt
https://example.com/schemas/abstract
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [dashy-config.schema.json](../../out/dashy-config.schema.json "open original schema") |
## Dashy Config Schema Type
`object` ([Dashy Config Schema](dashy-config.md))
# Dashy Config Schema Properties
| Property | Type | Required | Nullable | Defined by |
| :---------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------- |
| [pageInfo](#pageinfo) | `object` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-pageinfo.md "https://example.com/schemas/abstract#/properties/pageInfo") |
| [appConfig](#appconfig) | `object` | Optional | cannot be null | [Dashy Config Schema](dashy-config-properties-appconfig.md "https://example.com/schemas/abstract#/properties/appConfig") |
| [sections](#sections) | `array` | Required | cannot be null | [Dashy Config Schema](dashy-config-properties-sections.md "https://example.com/schemas/abstract#/properties/sections") |
## pageInfo
`pageInfo`
* is optional
* Type: `object` ([Details](dashy-config-properties-pageinfo.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-pageinfo.md "https://example.com/schemas/abstract#/properties/pageInfo")
### pageInfo Type
`object` ([Details](dashy-config-properties-pageinfo.md))
## appConfig
Application configuration
`appConfig`
* is optional
* Type: `object` ([Details](dashy-config-properties-appconfig.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-appconfig.md "https://example.com/schemas/abstract#/properties/appConfig")
### appConfig Type
`object` ([Details](dashy-config-properties-appconfig.md))
## sections
Array of sections, containing items
`sections`
* is required
* Type: `object[]` ([Details](dashy-config-properties-sections-items.md))
* cannot be null
* defined in: [Dashy Config Schema](dashy-config-properties-sections.md "https://example.com/schemas/abstract#/properties/sections")
### sections Type
`object[]` ([Details](dashy-config-properties-sections-items.md))