From bc391e285cef08115060ff7925ee177a7cfde5a6 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Tue, 26 Apr 2022 22:26:27 +0100 Subject: [PATCH] :card_file_box: Adds pages to config docs --- docs/configuring.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/configuring.md b/docs/configuring.md index 16e3bcce..e09bc4a6 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -27,6 +27,7 @@ The following file provides a reference of all supported configuration options. - [**`pageInfo`**](#pageinfo) - Header text, footer, title, navigation, etc - [`navLinks`](#pageinfonavlinks-optional) - Links to display in the navigation bar +- [**`pages`**](#pages-optional) - List of additional config files, for multi-page dashboards - [**`appConfig`**](#appconfig-optional) - Main application settings - [`webSearch`](#appconfigwebsearch-optional) - Configure web search engine options - [`hideComponents`](#appconfighidecomponents-optional) - Show/ hide page components @@ -56,6 +57,7 @@ The following file provides a reference of all supported configuration options. **`pageInfo`** | `object` | Required | Basic meta data like title, description, nav bar links, footer text. See [`pageInfo`](#pageinfo) **`appConfig`** | `object` | _Optional_ | Settings related to how the app functions, including API keys and global styles. See [`appConfig`](#appconfig-optional) **`sections`** | `array` | Required | An array of sections, each containing an array of items, which will be displayed as links. See [`section`](#section) +**`pages`** | `array` | _Optional_ | An array additional config files, used for multi-page dashboards. See [`pages`](#pages-optional) **[⬆️ Back to Top](#configuring)** @@ -81,6 +83,15 @@ The following file provides a reference of all supported configuration options. **[⬆️ Back to Top](#configuring)** +### `pages[]` _(optional)_ + +**Field** | **Type** | **Required**| **Description** +--- | --- | --- | --- +**`name`** | `string` | Required | A unique name for that page +**`path`** | `string` | Required | The path (local or remote) to the config file to use.
For files located within `/public`, you only need to specify filename, for externally hosted files you must include the full URL + +**[⬆️ Back to Top](#configuring)** + ### `appConfig` _(optional)_ **Field** | **Type** | **Required**| **Description**