Skip to content

Commit c33e2f6

Browse files
committed
📝 Add backup-note to config-files section
1 parent 242ef6c commit c33e2f6

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

src/content/docs/config-files.mdx

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,21 @@ tableOfContents:
1111
maxHeadingLevel: 6
1212
---
1313

14+
import { Icon } from 'astro-icon/components';
1415
import { Tabs, TabItem, Aside, FileTree, Badge } from '@astrojs/starlight/components';
1516

1617
![banner](../../assets/banners/banner03.png)
1718

1819
All settings of Kando are stored in **two configuration files** JSON files which you can edit with any text editor.
1920
[`config.json`](#general-configuration-configjson) stores the general configuration of the application and [`menus.json`](#menu-configuration-menusjson) stores the configuration of the individual menus.
2021

21-
<Aside type="tip" title="Edit the config files while Kando is running!">
22-
Whenever you save a file, Kando will automatically 🔥 **hot-reload** the configuration.
23-
Kando will ✅ **validate** the configuration files. If you [launched Kando from a
24-
terminal](../../launch-from-cli), it will print errors to the console if it finds any.
25-
In this case, the configuration will not be reloaded. If a configuration file is invalid
26-
at startup, Kando will refuse to start.
27-
</Aside>
22+
## <Icon name="solar:safe-2-bold-duotone" class="inline-icon" /> Backup your Menus and Settings!
23+
24+
It's a good idea to backup your menus and settings regularly, especially if you have spent a lot of time customizing them.
25+
As noted above, all of Kando's settings, including your menus, are stored in two JSON files.
26+
You can either backup these files manually, or use the corresponding buttons in the general settings dialog.
27+
28+
![Backup buttons](../../assets/img/backup-settings.png)
2829

2930
## Location of the Configuration Files
3031

@@ -73,6 +74,14 @@ Use you file manager or terminal to navigate to the following directories.
7374

7475
## General Configuration: `config.json`
7576

77+
<Aside type="tip" title="Edit the config files while Kando is running!">
78+
Whenever you save a file, Kando will automatically 🔥 **hot-reload** the configuration.
79+
Kando will ✅ **validate** the configuration files. If you [launched Kando from a
80+
terminal](../../launch-from-cli), it will print errors to the console if it finds any.
81+
In this case, the configuration will not be reloaded. If a configuration file is invalid
82+
at startup, Kando will refuse to start.
83+
</Aside>
84+
7685
This file contains the general configuration of Kando.
7786
Here you can configure the menu theme, sound theme, and various other settings.
7887
Below are the default values of the configuration file.

0 commit comments

Comments
 (0)