Skip to content

Commit 2cf41ab

Browse files
committed
📝 Add initial auto-start guide
1 parent b1b32ac commit 2cf41ab

4 files changed

Lines changed: 94 additions & 2 deletions

File tree

astro.config.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export default defineConfig({
4949
'creating-menus',
5050
{
5151
label: 'Available Item Types',
52+
collapsed: true,
5253
items: [
5354
'item-submenu',
5455
'item-run-command',
@@ -74,6 +75,7 @@ export default defineConfig({
7475
{
7576
label: 'Advanced Usage',
7677
items: [
78+
'autostart',
7779
'opening-menus',
7880
'portable-mode',
7981
'launch-from-cli',

src/assets/banners/banner15.png

703 KB
Loading

src/content/docs/autostart.mdx

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
title: Start Kando on Login
6+
description: Start Kando automatically when you log in to your system.
7+
---
8+
9+
import { CardGrid, Icon, Tabs, TabItem, Steps, Badge, FileTree } from '@astrojs/starlight/components';
10+
import CustomCard from '../../components/CustomCard.astro';
11+
import Intro from '../../components/Intro.astro';
12+
13+
![banner](../../assets/banners/banner15.png)
14+
15+
<Intro>
16+
Kando does not come with an automatic startup feature by default. However, you can easily configure your OS to start Kando automatically when you log in.
17+
</Intro>
18+
19+
20+
## <Icon name="seti:windows" class="inline-icon" /> Windows
21+
22+
To have Kando start automatically on Windows, you can add a shortcut to Kando in the "Startup" folder.
23+
To do this, follow these steps:
24+
25+
<Steps>
26+
27+
1. Press <kbd>Windows</kbd> + <kbd>R</kbd> to open the "Run" dialog.
28+
29+
2. Type `shell:startup` and press <kbd>Enter</kbd>. This will open the "Startup" folder.
30+
31+
3. Drag and drop a shortcut to Kando into this folder. You can create a shortcut by right-clicking on the Kando executable and selecting "Create shortcut".
32+
33+
</Steps>
34+
35+
## <Icon name="apple" class="inline-icon" /> macOS
36+
37+
On macOS, you can add Kando to your login items to have it start automatically when you log in.
38+
To do this, follow these steps:
39+
40+
<Steps>
41+
42+
1. Open "System Settings" from the Apple menu.
43+
44+
2. Go to "Users & Groups".
45+
46+
3. Select your user account and click on "Login Items".
47+
48+
4. Click the "+" button and add Kando to the list.
49+
50+
</Steps>
51+
52+
## <Icon name="linux" class="inline-icon" /> Linux
53+
54+
Most desktop environments on Linux come with a GUI to manage applications that should start on login.
55+
However, most of the time it is also possible to add startup applications manually by placing a `.desktop` file into `~/.config/autostart/`.
56+
57+
So first, create this directory if it does not exist yet:
58+
59+
```bash
60+
mkdir ~/.config/autostart
61+
```
62+
Then create a file named `kando.desktop` in this directory with the following content.
63+
The exec command depends on how you installed Kando.
64+
Here are three common options:
65+
66+
<Tabs syncKey="os">
67+
<TabItem label="Local Installation">
68+
```ini title=~/.config/autostart/kando.desktop
69+
[Desktop Entry]
70+
Type=Application
71+
Name=Kando
72+
Exec=/full/path/to/kando
73+
```
74+
</TabItem>
75+
<TabItem label="System-wide Installation">
76+
```ini title=~/.config/autostart/kando.desktop
77+
[Desktop Entry]
78+
Type=Application
79+
Name=Kando
80+
Exec=kando
81+
```
82+
</TabItem>
83+
<TabItem label="Flatpak Installation">
84+
```ini title=~/.config/autostart/kando.desktop
85+
[Desktop Entry]
86+
Type=Application
87+
Name=Kando
88+
Exec=flatpak run menu.kando.Kando
89+
```
90+
</TabItem>
91+
</Tabs>

src/content/docs/portable-mode.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ sidebar:
1010
variant: tip
1111
---
1212

13-
import { CardGrid, Aside, Tabs, TabItem, Steps, Badge, FileTree } from '@astrojs/starlight/components';
14-
import CustomCard from '../../components/CustomCard.astro';
13+
import { Aside, Badge } from '@astrojs/starlight/components';
1514
import Intro from '../../components/Intro.astro';
1615
import { Icon } from 'astro-icon/components';
1716

0 commit comments

Comments
 (0)