Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Round 1 #16

Merged
merged 6 commits into from
Jun 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/config-schema/README.md
Original file line number Diff line number Diff line change
@@ -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#`
Original file line number Diff line number Diff line change
@@ -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`
Original file line number Diff line number Diff line change
@@ -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`
Original file line number Diff line number Diff line change
@@ -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[]`
Original file line number Diff line number Diff line change
@@ -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`
Original file line number Diff line number Diff line change
@@ -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
```
Original file line number Diff line number Diff line change
@@ -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`
Original file line number Diff line number Diff line change
@@ -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))
Original file line number Diff line number Diff line change
@@ -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")
Original file line number Diff line number Diff line change
@@ -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 changes: 179 additions & 0 deletions docs/config-schema/dashy-config-properties-appconfig.md
Original file line number Diff line number Diff line change
@@ -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`
Loading