Skip to content

Commit b1b32ac

Browse files
committed
📝 Add portable mode docs
1 parent ed47ed6 commit b1b32ac

4 files changed

Lines changed: 49 additions & 0 deletions

File tree

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ export default defineConfig({
7575
label: 'Advanced Usage',
7676
items: [
7777
'opening-menus',
78+
'portable-mode',
7879
'launch-from-cli',
7980
],
8081
},

src/assets/banners/banner14.png

662 KB
Loading

src/content/docs/config-files.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ Use you file manager or terminal to navigate to the following directories.
6363

6464
</FileTree>
6565

66+
<Aside type="note" title="Portable Mode">
67+
If [portable mode](/portable-mode) is enabled, Kando will load and save the configuration files from the directory specified in the `portableMode.json` file instead.
68+
</Aside>
69+
6670

6771

6872
## General Configuration: `config.json`

src/content/docs/portable-mode.mdx

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: Portable Mode
6+
description: Learn how to use Kando in portable mode.
7+
sidebar:
8+
badge:
9+
text: soon!
10+
variant: tip
11+
---
12+
13+
import { CardGrid, Aside, Tabs, TabItem, Steps, Badge, FileTree } from '@astrojs/starlight/components';
14+
import CustomCard from '../../components/CustomCard.astro';
15+
import Intro from '../../components/Intro.astro';
16+
import { Icon } from 'astro-icon/components';
17+
18+
![banner](../../assets/banners/banner14.png)
19+
20+
<Intro>
21+
Kando can be configured to load and save all its [configuration files](/config-files) in its installation directory.
22+
In fact, you can set any directory as Kando's configuration directory.
23+
</Intro>
24+
25+
<Aside type="danger" title="Not available yet!">
26+
Portable mode will be available in an upcoming release of Kando. Stay tuned!
27+
</Aside>
28+
29+
## <Icon name="solar:planet-3-bold-duotone" class="inline-icon" /> Enabling Portable Mode <Badge text="soon!" variant="tip" />
30+
31+
To enable portable mode, you need to create a `portableMode.json` next to the Kando executable.
32+
So for instance if you downloaded the Kando zip archive from GitHub and extracted it, you would create the file in the extracted folder.
33+
34+
```json title=portableMode.json
35+
{
36+
// The path to the configuration directory.
37+
// This can be an absolute path or a path relative to this file.
38+
"configDirectory": "config"
39+
}
40+
```
41+
42+
The above example would make Kando load and save its configuration files in a subfolder named `config` next to the executable.
43+
If you specified an absolute path instead, Kando would use that path.
44+
This way, you can also use portable mode to load and save the configuration files in any other directory on your system.

0 commit comments

Comments
 (0)