Skip to content

Commit ab6850a

Browse files
authored
improve kbd docs (#1707)
* improve kbd docs
1 parent 5f5e48f commit ab6850a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/authoring/_kbd.qmd

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
{{< include ../_require-1.3.qmd >}}
22

3-
The `kbd` [shortcode](shortcodes.qmd) can be used to describe keyboard shortcuts in documentation. On Javascript formats, it will attempt to detect the operating system of the format and show the correct shortcut. On print formats, it will print the keyboard shortcut information for all operating systems.
3+
The `kbd` [shortcode](shortcodes.qmd) can be used to describe keyboard shortcuts in documentation:
4+
5+
- single keyboard shortcuts for every operating system use a **positional parameter**: `{{{< kbd Ctrl-C >}}}`
6+
- different shortcuts for different operating systems use **keyword parameters `win`, `mac`, and `linux`**: `{{{< kbd mac=Shift-Command-O win=Shift-Control-O linux=Shift-Ctrl-L >}}}`
7+
8+
On Javascript formats, Quarto will attempt to detect the operating system of the format and show the correct shortcut.
9+
On print formats, it will print the keyboard shortcut information for all operating systems.
410

511
For example, writing the following markdown:
612

0 commit comments

Comments
 (0)