mirror of
https://github.com/Lissy93/dashy.git
synced 2024-12-27 19:03:39 +03:00
📝 Updates docs with new config editor
This commit is contained in:
parent
1b0bf787a1
commit
bd96d148f8
17
README.md
17
README.md
@ -64,9 +64,6 @@
|
||||
</p>
|
||||
</details>
|
||||
|
||||
| 👉 PSA: Want Free Swag? [Dashy is participating in Hacktoberfest 2021!](https://github.com/Lissy93/dashy/discussions/281) |
|
||||
|-|
|
||||
|
||||
## Features 🌈
|
||||
|
||||
- 🔎 Instant search by name, domain and tags + customizable hotkeys & keyboard shortcuts
|
||||
@ -405,15 +402,21 @@ Hit `Esc` at anytime to close any open apps, clear the search field, or hide any
|
||||
## Config Editor ⚙️
|
||||
> For full config documentation, see: [**Configuring**](./docs/configuring.md)
|
||||
|
||||
From the Settings Menu in Dashy, you can download, backup, edit and rest your config. The editor will tell you if you've got any validation warnings.
|
||||
As well as passing in a YAML config file, you can also configure the app directly through the UI, and preview changes live.
|
||||
|
||||
A full list of available config options can be found [here](./docs/configuring.md). It's recommend to make a backup of your configuration, as you can then restore it into a new instance of Dashy, without having to set it up again. [json2yaml](https://www.json2yaml.com/) is very useful for converting between YAML to JSON and visa versa.
|
||||
To edit any section or item, right-click on it, and select "Edit", or enter the Edit Mode (using the Pen icon in the top-right), then click any part of the page to edit. Changes will be visible immediately, but will not be saved until you click "Save to Disk" or "Save Locally".
|
||||
|
||||
<p align="center">
|
||||
<img alt="Interactive Editor demo" src="https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif" width="600" />
|
||||
</p>
|
||||
|
||||
Under the config menu, you can export, view, backup, or reset app config, as well as edit the raw config file in a text editor, with built-in schema validation.
|
||||
|
||||
<p align="center">
|
||||
<img alt="Config Editor demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600" />
|
||||
</p>
|
||||
|
||||
**Update:** A new and improved drag-and-drop UI editor is in progress, and should be released within the next couple of weeks!
|
||||
A full list of available config options can be found [here](./docs/configuring.md). It's recommend to make and keep a backup of your configuration, to easily restore it into a new instance of Dashy.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
@ -449,6 +452,7 @@ Dashy supports multiple languages and locales. When available, you're language s
|
||||
- 🇲🇫 **French**: `fr` - Contributed by **[@EVOTk](https://github.com/EVOTk)**
|
||||
- 🇩🇪 **German**: `de` - Contributed by **[@Niklashere](https://github.com/Niklashere)**
|
||||
- 🇳🇴 **Norwegian Bokmål**: `nb` - Contributed by **[@rubjo](https://github.com/rubjo)**
|
||||
- 🇵🇱 **Polish**: `pl` - Contributed by **[@skaarj1989](https://github.com/skaarj1989)**
|
||||
- 🇪🇸 **Spanish**: `es` - Contributed by **[@lu4t](https://github.com/lu4t)**
|
||||
- 🇸🇮 **Slovenian**: `sl` - Contributed by **[@UrekD](https://github.com/UrekD)**
|
||||
- 🇮🇹 **Italian**: `it` - Machine Translated *(awaiting human review)*
|
||||
@ -457,7 +461,6 @@ Dashy supports multiple languages and locales. When available, you're language s
|
||||
- 🇦🇪 **Arabic**: `ar` - Contributed by Anon
|
||||
- 🇮🇳 **Hindi**: `hi` - Contributed by Anon
|
||||
- 🇯🇵 **Japanese**: `ja` - Contributed by Anon
|
||||
- 🇵🇱 **Polish**: `pl` - Contributed by **[@skaarj1989](https://github.com/skaarj1989)**
|
||||
|
||||
#### Add your Language
|
||||
I would love for Dashy to be available to everyone, without language being a barrier to entry for non-native English speakers. If you have a few minutes to spare, you're help with translating it would be very much appreciated.
|
||||
|
@ -1,6 +1,8 @@
|
||||
# Configuring
|
||||
|
||||
All app configuration is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) which is in [YAML Format](https://yaml.org/) format.
|
||||
All app configuration is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) which is in [YAML Format](https://yaml.org/) format. Changes can also be made [directly through the UI](#editing-config-through-the-ui) and previewed live, from here you can also export, backup, reset, validate and download your configuration file.
|
||||
|
||||
The following file provides a reference of all supported configuration options.
|
||||
|
||||
---
|
||||
|
||||
@ -20,10 +22,11 @@ All app configuration is specified in [`/public/conf.yml`](https://github.com/Li
|
||||
- [`items`](#sectionitem) - List of items
|
||||
- [`icon`](#sectionicon-and-sectionitemicon) - Icon for an item
|
||||
- [**Notes**](#notes)
|
||||
- [Editing Config through the UI](#editing-config-through-the-ui)
|
||||
- [About YAML](#about-yaml)
|
||||
- [Config Saving Methods](#config-saving-methods)
|
||||
- [Preventing Changes](#preventing-changes-being-written-to-disk)
|
||||
- [Example](#example)
|
||||
- [Example](#example)
|
||||
|
||||
---
|
||||
|
||||
@ -227,6 +230,22 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
|
||||
|
||||
## Notes
|
||||
|
||||
### Editing Config through the UI
|
||||
|
||||
Config can be modified directly through the UI, and then written to disk, or applied locally. This can be done wither with the raw config editor (introduced in V 0.6.5 / [#3](https://github.com/Lissy93/dashy/pull/3)), or the interactive editor (introduced in V 1.8.9 / [#298](https://github.com/Lissy93/dashy/pull/298)).
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ibb.co/CzkyMNb">
|
||||
<b>Interactive Editor</b><br>
|
||||
<img alt="Interactive Editor demo" src="https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif" width="600" />
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://ibb.co/zRv542H">
|
||||
<b>Raw Editor</b><br>
|
||||
<img alt="Config Editor demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### About YAML
|
||||
If you're new to YAML, it's pretty straight-forward. The format is exactly the same as that of JSON, but instead of using curly braces, structure is denoted using whitespace. This [quick guide](https://linuxhandbook.com/yaml-basics/) should get you up to speed in a few minutes, for more advanced topics take a look at this [Wikipedia article](https://en.wikipedia.org/wiki/YAML).
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user