mirror of https://github.com/lissy93/dashy
📝 Updates multi-page docs
This commit is contained in:
Alicia Sykes
parent
138003c9b4
commit
f6df1e7750
45
README.md
45
README.md
|
|
@ -48,6 +48,7 @@
|
|||
- [⚙️ Config Editor](#config-editor-)
|
||||
- [☁ Cloud Backup & Sync](#cloud-backup--sync-)
|
||||
- [🌎 Language Switching](#language-switching-)
|
||||
- [📃 Multi-Page Support](#multi-page-support-)
|
||||
- **Community**
|
||||
- [📊 System Requirements](#system-requirements-)
|
||||
- [🙋♀️ Support](#support-)
|
||||
|
|
@ -64,18 +65,18 @@
|
|||
</details>
|
||||
|
||||
## Features 🌈
|
||||
|
||||
- 📃 Support for multiple pages
|
||||
- 🚦 Real-time status monitoring for each of your apps/links
|
||||
- 📊 Use widgets to display info and dynamic content from self-hosted services
|
||||
- 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
|
||||
- 🎨 Many built-in color themes, with UI color editor and support for custom CSS
|
||||
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
|
||||
- 🚦 Status monitoring for each of your apps/links for basic availability and uptime checking
|
||||
- 📊 Use widgets to display info and dynamic content from self-hosted services
|
||||
- 💂 Optional authentication with multi-user access, configurable privileges, and SSO support
|
||||
- 🌎 Multi-language support, with 10+ human-translated languages, and more on the way
|
||||
- ☁ Optional, encrypted, free off-site cloud backup and restore feature available
|
||||
- 💼 A workspace view, for easily switching between multiple apps simultaneously
|
||||
- 🛩️ A minimal view, for use as a fast-loading browser Startpage
|
||||
- 🖱️ Choose app launch method, either new tab, same tab, a pop-up modal, or in the workspace view
|
||||
- 🖱️ Choose app launch methods: new tab, same tab, clipboard, pop-up modal, or open in workspace view
|
||||
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior, etc.
|
||||
- 🖼️ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.
|
||||
- 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
|
||||
|
|
@ -413,11 +414,11 @@ Dashy supports multiple languages and locales. When available, your language sho
|
|||
- 🇸🇮 **Slovenian**: `sl` - Contributed by **[@UrekD](https://github.com/UrekD)**
|
||||
- 🇸🇪 **Swedish**: `sv` - Contributed by **[@BOZG](https://github.com/BOZG)**
|
||||
- 🇮🇹 **Italian**: `it` - Contributed by **[@alexdelprete](https://github.com/alexdelprete)**
|
||||
- 🇵🇹 **Portuguese**: `pt` - Machine Translated *(awaiting human review)*
|
||||
- 🇵🇹 **Portuguese**: `pt` - Contributed by **[@LeoColman](https://github.com/LeoColman)**
|
||||
- 🇷🇺 **Russian**: `ru` - Contributed by Anon
|
||||
- 🇦🇪 **Arabic**: `ar` - Contributed by Anon
|
||||
- 🇮🇳 **Hindi**: `hi` - Contributed by Anon
|
||||
- 🇯🇵 **Japanese**: `ja` - Contributed by Anon
|
||||
- 🇦🇪 **Arabic**: `ar`
|
||||
- 🇮🇳 **Hindi**: `hi`
|
||||
- 🇯🇵 **Japanese**: `ja`
|
||||
|
||||
#### Add your Language
|
||||
I would love Dashy to be available to everyone without language being a barrier to entry. If you've got a few minutes to spare, consider adding translations for your language. It's a quick task, and all text is in [a single JSON file](https://github.com/Lissy93/dashy/tree/master/src/assets/locales). Since any missing text will fall back to English, you don't need to translate it all.
|
||||
|
|
@ -426,6 +427,34 @@ I would love Dashy to be available to everyone without language being a barrier
|
|||
|
||||
---
|
||||
|
||||
## Multi-Page Support 📃
|
||||
|
||||
> For full multi-page documentation, see: [**Pages & Sections**](./docs/pages-and-sections.md)
|
||||
|
||||
Within your dashboard, you can have as many sub-pages as you require. To load additional pages, specify a name, and path to a config file under `pages`. The config file can be either local (stored in `/public`), or remote (located anywhere accessible).
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Networking Services
|
||||
path: 'networking.yml'
|
||||
- name: Work Stuff
|
||||
path: 'work.yml'
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Getting Started
|
||||
path: 'https://snippet.host/tvcw/raw'
|
||||
- name: Homelab
|
||||
path: 'https://snippet.host/tetp/raw'
|
||||
- name: Browser Startpage
|
||||
path: 'https://snippet.host/zcom/raw'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## System Requirements 📊
|
||||
|
||||
If running on bare metal, Dashy requires [Node](https://nodejs.org/en/) V 16.0.0 or later, LTS (16.13.2) is recommended.
|
||||
|
|
|
|||
|
|
@ -4,9 +4,7 @@
|
|||
|
||||
You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar.
|
||||
|
||||
Note that the only top-level fields supported by sub-pages are `pageInfo` and `sections`. The `appConfig` and `pages` will always be inherited from your main `conf.yml` file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo.
|
||||
|
||||
You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.
|
||||
You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.
|
||||
|
||||
### Using Local Sub-Pages
|
||||
|
||||
|
|
@ -52,3 +50,9 @@ The following example shows creating a config, publishing it as a [Gist](https:/
|
|||
src="https://i.ibb.co/55jm3LG/how-to-use-remote-config-sub-page.gif"
|
||||
/>
|
||||
</p>
|
||||
|
||||
### Restrictions
|
||||
|
||||
Only top-level fields supported by sub-pages are `pageInfo` and `sections`. The `appConfig` and `pages` will always be inherited from your main `conf.yml` file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo.
|
||||
|
||||
Note that since page paths are required by the router, they are set at build-time, not run-time, and so a rebuild (happens automatically) is required for changes to page paths to take effect (this only applies to changes to the `pages` array, rebuild isn't required for editing page content).
|
||||
|
|
|
|||
Loading…
Reference in New Issue