From 41f8d06899685d7b9754e4929d4c754162382166 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 25 Jul 2021 14:25:20 +0100 Subject: [PATCH] :put_litter_in_its_place: Deleted old config docs --- docs/config-schema/README.md | 35 --- ...ties-appconfig-properties-backgroundimg.md | 15 - ...es-appconfig-properties-cssthemes-items.md | 15 - ...operties-appconfig-properties-cssthemes.md | 15 - ...operties-appconfig-properties-customcss.md | 15 - ...-appconfig-properties-enablefontawesome.md | 23 -- ...fig-properties-externalstylesheet-items.md | 15 - ...appconfig-properties-externalstylesheet.md | 15 - ...ies-appconfig-properties-fontawesomekey.md | 25 -- ...g-properties-appconfig-properties-theme.md | 23 -- .../dashy-config-properties-appconfig.md | 179 ------------ ...perties-pageinfo-properties-description.md | 15 - ...operties-pageinfo-properties-footertext.md | 15 - ...operties-navlinks-items-properties-path.md | 15 - ...perties-navlinks-items-properties-title.md | 15 - ...ties-pageinfo-properties-navlinks-items.md | 58 ---- ...properties-pageinfo-properties-navlinks.md | 19 -- ...ig-properties-pageinfo-properties-title.md | 15 - .../dashy-config-properties-pageinfo.md | 100 ------- ...erties-displaydata-properties-collapsed.md | 15 - ...properties-displaydata-properties-color.md | 15 - ...-properties-displaydata-properties-cols.md | 29 -- ...ies-displaydata-properties-customstyles.md | 15 - ...rties-displaydata-properties-itemcountx.md | 21 -- ...rties-displaydata-properties-itemcounty.md | 21 -- ...perties-displaydata-properties-itemsize.md | 33 --- ...roperties-displaydata-properties-layout.md | 32 --- ...-properties-displaydata-properties-rows.md | 29 -- ...s-sections-items-properties-displaydata.md | 266 ------------------ ...operties-sections-items-properties-icon.md | 15 - ...properties-items-items-properties-color.md | 15 - ...ties-items-items-properties-description.md | 15 - ...-properties-items-items-properties-icon.md | 15 - ...perties-items-items-properties-provider.md | 15 - ...roperties-items-items-properties-target.md | 33 --- ...properties-items-items-properties-title.md | 15 - ...s-properties-items-items-properties-url.md | 15 - ...s-sections-items-properties-items-items.md | 171 ----------- ...perties-sections-items-properties-items.md | 15 - ...operties-sections-items-properties-name.md | 15 - .../dashy-config-properties-sections-items.md | 96 ------- .../dashy-config-properties-sections.md | 15 - docs/config-schema/dashy-config.md | 77 ----- 43 files changed, 1630 deletions(-) delete mode 100644 docs/config-schema/README.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-backgroundimg.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes-items.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-customcss.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-enablefontawesome.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet-items.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-fontawesomekey.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig-properties-theme.md delete mode 100644 docs/config-schema/dashy-config-properties-appconfig.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-description.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-footertext.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo-properties-title.md delete mode 100644 docs/config-schema/dashy-config-properties-pageinfo.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-color.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-cols.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-layout.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-rows.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-displaydata.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-icon.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-color.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-description.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-icon.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-provider.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-target.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-title.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-url.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items-items.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-items.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items-properties-name.md delete mode 100644 docs/config-schema/dashy-config-properties-sections-items.md delete mode 100644 docs/config-schema/dashy-config-properties-sections.md delete mode 100644 docs/config-schema/dashy-config.md diff --git a/docs/config-schema/README.md b/docs/config-schema/README.md deleted file mode 100644 index 6e16ab8d..00000000 --- a/docs/config-schema/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# 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#` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-backgroundimg.md b/docs/config-schema/dashy-config-properties-appconfig-properties-backgroundimg.md deleted file mode 100644 index 3a377562..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-backgroundimg.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes-items.md b/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes-items.md deleted file mode 100644 index 15e80729..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes.md b/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes.md deleted file mode 100644 index f09a4390..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-cssthemes.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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[]` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-customcss.md b/docs/config-schema/dashy-config-properties-appconfig-properties-customcss.md deleted file mode 100644 index a8833b10..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-customcss.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-enablefontawesome.md b/docs/config-schema/dashy-config-properties-appconfig-properties-enablefontawesome.md deleted file mode 100644 index 706468b4..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-enablefontawesome.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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 -``` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet-items.md b/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet-items.md deleted file mode 100644 index 43937852..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet.md b/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet.md deleted file mode 100644 index 583aaf06..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-externalstylesheet.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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)) diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-fontawesomekey.md b/docs/config-schema/dashy-config-properties-appconfig-properties-fontawesomekey.md deleted file mode 100644 index dfb982a0..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-fontawesomekey.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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") diff --git a/docs/config-schema/dashy-config-properties-appconfig-properties-theme.md b/docs/config-schema/dashy-config-properties-appconfig-properties-theme.md deleted file mode 100644 index bc090a99..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig-properties-theme.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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" -``` diff --git a/docs/config-schema/dashy-config-properties-appconfig.md b/docs/config-schema/dashy-config-properties-appconfig.md deleted file mode 100644 index af63de7c..00000000 --- a/docs/config-schema/dashy-config-properties-appconfig.md +++ /dev/null @@ -1,179 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-description.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-description.md deleted file mode 100644 index b2636bdc..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-description.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-footertext.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-footertext.md deleted file mode 100644 index 9d75c2e8..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-footertext.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md deleted file mode 100644 index 79fc5bf7..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-path.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md deleted file mode 100644 index 6c891714..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items-properties-title.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items.md deleted file mode 100644 index 48a7abb4..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks-items.md +++ /dev/null @@ -1,58 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks.md deleted file mode 100644 index 2e4a9768..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-navlinks.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo-properties-title.md b/docs/config-schema/dashy-config-properties-pageinfo-properties-title.md deleted file mode 100644 index 25f1ad49..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo-properties-title.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-pageinfo.md b/docs/config-schema/dashy-config-properties-pageinfo.md deleted file mode 100644 index d9494696..00000000 --- a/docs/config-schema/dashy-config-properties-pageinfo.md +++ /dev/null @@ -1,100 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md deleted file mode 100644 index 1bed4095..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-collapsed.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-color.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-color.md deleted file mode 100644 index 32035b0b..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-color.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-cols.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-cols.md deleted file mode 100644 index ea688ea1..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-cols.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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 -``` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md deleted file mode 100644 index 7e5ece63..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-customstyles.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md deleted file mode 100644 index 9cb308ce..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcountx.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md deleted file mode 100644 index 995ba7c1..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemcounty.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md deleted file mode 100644 index a76d28dc..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-itemsize.md +++ /dev/null @@ -1,33 +0,0 @@ -# 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" -``` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-layout.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-layout.md deleted file mode 100644 index edd259a1..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-layout.md +++ /dev/null @@ -1,32 +0,0 @@ -# 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" -``` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-rows.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-rows.md deleted file mode 100644 index a4ae3938..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata-properties-rows.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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 -``` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata.md b/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata.md deleted file mode 100644 index 9a671c19..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-displaydata.md +++ /dev/null @@ -1,266 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-icon.md b/docs/config-schema/dashy-config-properties-sections-items-properties-icon.md deleted file mode 100644 index d148087e..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-icon.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-color.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-color.md deleted file mode 100644 index fb6ef980..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-color.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-description.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-description.md deleted file mode 100644 index 38bbcc65..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-description.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-icon.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-icon.md deleted file mode 100644 index 47297239..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-icon.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-provider.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-provider.md deleted file mode 100644 index f6f1ea1c..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-target.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-target.md deleted file mode 100644 index 9374264e..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-target.md +++ /dev/null @@ -1,33 +0,0 @@ -# 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" -``` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-title.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-title.md deleted file mode 100644 index b9553290..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-title.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-url.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-url.md deleted file mode 100644 index b3c69915..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items-properties-url.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items-items.md deleted file mode 100644 index b51f451d..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items-items.md +++ /dev/null @@ -1,171 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-items.md b/docs/config-schema/dashy-config-properties-sections-items-properties-items.md deleted file mode 100644 index d74bbcde..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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)) diff --git a/docs/config-schema/dashy-config-properties-sections-items-properties-name.md b/docs/config-schema/dashy-config-properties-sections-items-properties-name.md deleted file mode 100644 index 735db51a..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items-properties-name.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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` diff --git a/docs/config-schema/dashy-config-properties-sections-items.md b/docs/config-schema/dashy-config-properties-sections-items.md deleted file mode 100644 index 81f56829..00000000 --- a/docs/config-schema/dashy-config-properties-sections-items.md +++ /dev/null @@ -1,96 +0,0 @@ -# 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)) diff --git a/docs/config-schema/dashy-config-properties-sections.md b/docs/config-schema/dashy-config-properties-sections.md deleted file mode 100644 index 54262fd9..00000000 --- a/docs/config-schema/dashy-config-properties-sections.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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)) diff --git a/docs/config-schema/dashy-config.md b/docs/config-schema/dashy-config.md deleted file mode 100644 index ea600c88..00000000 --- a/docs/config-schema/dashy-config.md +++ /dev/null @@ -1,77 +0,0 @@ -# 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))