Skip to content

Commit dabaaae

Browse files
committed
📝 Some docs updates
1 parent 2296c28 commit dabaaae

File tree

5 files changed

+30
-26
lines changed

5 files changed

+30
-26
lines changed

src/content/docs/compile-from-source.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Compile Kando from Source
5+
title: Compiling Kando from Source
66
description: A guide on how to compile Kando from source.
77
sidebar:
88
order: 3

src/content/docs/contribution-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Write Code for Kando
5+
title: Writing Code for Kando
66
description: Some guidelines for contributing to Kando.
77
sidebar:
88
order: 4

src/content/docs/creating-menus.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Create Your First Menu
5+
title: Create Your First Menu!
66
description: Learn how to create your first menu in Kando.
77
next:
88
link: /opening-menus
@@ -53,7 +53,7 @@ Click on an item to learn more about it!
5353
<LinkCard title="Redirect to another Menu" description='Use this as a link to another menu.' href="/item-redirect"/>
5454
<LinkCard title="Open Settings" description="Opens Kando's settings dialog." href="/item-settings"/>
5555

56-
## Tips for Efficient Menu Layouts
56+
## <Icon name="solar:lightbulb-minimalistic-bold-duotone" class="inline-icon" /> Tips for Efficient Menu Layouts
5757

5858
Just like with any other user interface, the layout of your menus is crucial for a good user experience.
5959
Here are some tips to help you create efficient and user-friendly menus!

src/content/docs/opening-menus.mdx

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Opening Menus with the Mouse
6-
description: How to open Kando menus with mouse buttons.
5+
title: Opening Menus with Mouse Buttons
6+
description: How to open Kando menus with mouse buttons or touch gestures.
77
prev:
88
link: /creating-menus
99
label: Create Your First Menu
@@ -15,15 +15,30 @@ import Intro from '../../components/Intro.astro';
1515
![banner](../../assets/banners/banner12.png)
1616

1717
<Intro>
18-
While Kando does not have a cross-platform way to open menus with a mouse button, there are many platform-dependent third-party tools which can help you with this.
18+
While Kando does not have a builtin way to open menus with mouse buttons or touch gestures, there are many platform-dependent third-party tools which can help you with this.
1919
</Intro>
2020

21-
With some creativity, you can open menus not only with mouse buttons but also with gestures, desktop widgets, or in many other ways.
21+
## How to Open Menus From Other Tools
2222

23-
## Opening Menus Externally
23+
You can either make the third-party tool open the menu by simulation the shortcut for the menu, or it can directly call the Kando executable with the `--menu "menu name"` argument.
2424

25-
**You can either make the third-party tool open the menu by simulation the shortcut for the menu, or it can directly call the Kando executable with the `--menu "menu name"` argument.**
25+
### Option 1: Simulate the Shortcut
2626

27+
If the third-party tool supports simulating keyboard shortcuts, it is recommended to use this method.
28+
In most cases, this will be a bit faster then option 2.
29+
30+
You can choose any shortcut you like!
31+
Using one which does not interfere with you workflow is a good idea.
32+
For instance <kbd>Ctrl</kbd>+<kbd>F13</kbd> is usually not used by any application, so it is a good choice.
33+
34+
<Aside type="tip" title="Use a modifier key!">
35+
Kando menus can be called with single-key shortcuts, but this is not recommended.
36+
Turbo mode will only work properly if the shortcut includes a modifier like <kbd>Ctrl</kbd>, <kbd>Alt</kbd>, or <kbd>Shift</kbd>.
37+
</Aside>
38+
39+
### Option 2: Use the `--menu` Argument
40+
41+
With the `--menu` argument, you can open a Kando menu by calling the Kando executable with the name of the menu you want to open.
2742
Depending on your operating system, the command to open a Kando menu would look like this:
2843

2944
<Tabs syncKey='os'>
@@ -49,22 +64,12 @@ Depending on your operating system, the command to open a Kando menu would look
4964
</TabItem>
5065
</Tabs>
5166

52-
<Aside type="tip" title="Simulate the shortcut if possible!">
53-
If the third-party tool supports simulating keyboard shortcuts, it is recommended to use this method.
54-
Opening a menu by calling the Kando executable will usually be a bit slower than simulating the shortcut.
55-
</Aside>
56-
57-
## Rebinding Mouse Buttons
58-
59-
Many mice come with special drivers which allow you to rebind mouse buttons to keyboard shortcuts.
60-
If your mouse supports this, you can rebind a mouse button to a keyboard shortcut (e.g., <kbd>Ctrl</kbd> + <kbd>F13</kbd>) and then use this shortcut to open a Kando menu.
61-
62-
This is a very easy way to open menus with a mouse button.
63-
If you do not have such a driver, you can use third-party tools to remap mouse buttons to keyboard shortcuts.
64-
6567
## Third-Party Tools for Opening Menus
6668

67-
Below are some applications which can help you to open menus in various ways.
69+
Many mice come with special drivers which allow you to rebind mouse buttons to keyboard shortcuts or to run arbitrary commands.
70+
If your mouse supports this, this is an easy way to
71+
72+
If you do not have such a driver, you can use any of the third-party tools listed below.
6873
Most of them are free and open-source.
6974

7075
<Tabs syncKey='os'>
@@ -89,7 +94,6 @@ Most of them are free and open-source.
8994
</TabItem>
9095
</Tabs>
9196

92-
<br/>
9397
<br/>
9498

9599
<Aside type="note" title="Have you discovered another cool tool?">

src/content/docs/translating.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
33
# SPDX-License-Identifier: CC-BY-4.0
44

5-
title: Translate Kando
5+
title: Translate Kando!
66
description: Translate Kando into your language.
77
tableOfContents: false
88
sidebar:

0 commit comments

Comments
 (0)