Skip to content

Commit 239c1dc

Browse files
updated keyboard shortcut style
1 parent 1d235d0 commit 239c1dc

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

src/content/docs/style-guide/formatting/keyboard-keys.mdx

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,24 @@ title: Keyboard keys
44

55
---
66

7-
Use *select* instead of *click* when directing users to choose or select objects, commands, or options. Use *press* only when referring to pressing keys on a keyboard.
7+
## Wording
8+
9+
- Use **select** instead of **click** when directing users to choose or select objects, commands, or options.
10+
- Use **press** only when referring to pressing keys on a keyboard.
11+
12+
## Formatting
13+
14+
When telling readers what keyboard shortcuts to use to achieve a result:
15+
- Place the keyboard shortcut in between backticks (monospace formatting)
16+
- Use uppercase letters with the abbreviated version of the key (`CTRL` instead of `CONTROL`, `CMD` instead of `COMMAND`for example)
17+
- Wrap the complete keyboard shortcut in between backticks, including the plus sign:
18+
- **Do**:
19+
```mdx
20+
`CTRL + C`
21+
```
22+
23+
- **Don't**:
24+
```mdx
25+
`CTRL` + `C`
26+
```
27+
- Do not use the old `<kbd></kbd>` component

0 commit comments

Comments
 (0)