Keyboard shortcuts

You can represent keyboard keys and shortcuts in your documentation using the {kbd} role. This is useful for showing keyboard commands and shortcuts in a visually consistent way. See the full list of available keys.

To display a keyboard key, use the syntax {kbd}`key-name`. For example, writing {kbd}`enter` will render as a styled keyboard key.

Press {kbd}`enter` to submit.

For keyboard shortcuts involving multiple keys, you can combine them within a single {kbd} role by separating the key names with a +. Keys are always visually separated, even when using the combined syntax.

Use {kbd}`cmd+shift+enter` to execute the command.

To display alternative keys for a shortcut, use | to separate the alternate keys within the same {kbd} role. This is useful for showing platform-specific shortcuts, such as ctrl on Windows and cmd on macOS.

Use {kbd}`ctrl|cmd + c` to copy text.

The + and | characters have special meaning for combining keys and specifying alternatives. To render them as literal keys, you must use their keyword equivalents.

• To display the + key, use `{kbd}`plus`.
• To display the | key, use `{kbd}`pipe`.

The platform-specific examples below demonstrate how to combine special keys and regular characters.

| Mac              | Windows/Linux     | Description                 |
|------------------|-------------------|-----------------------------|
| {kbd}`cmd+c`     | {kbd}`ctrl+c`     | Copy                        |
| {kbd}`cmd+v`     | {kbd}`ctrl+v`     | Paste                       |
| {kbd}`cmd+z`     | {kbd}`ctrl+z`     | Undo                        |
| {kbd}`cmd+enter` | {kbd}`ctrl+enter` | Run a query                 |
| {kbd}`cmd+/`     | {kbd}`ctrl+/`     | Comment or uncomment a line |

The {kbd} role recognizes a set of special keywords for modifier, navigation, and function keys. Any other text will be rendered as a literal key.

Here is the full list of available keywords: