diff --git a/src/content/docs/style-guide/formatting/keyboard-keys.mdx b/src/content/docs/style-guide/formatting/keyboard-keys.mdx index b8ed7bdc34517ae..f9ce43c069512b1 100644 --- a/src/content/docs/style-guide/formatting/keyboard-keys.mdx +++ b/src/content/docs/style-guide/formatting/keyboard-keys.mdx @@ -4,4 +4,24 @@ title: Keyboard keys --- -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. +## Wording + +- 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. + +## Formatting keyboard shortcuts + +When telling readers what keyboard shortcuts to use to achieve a result: +- Place the keyboard shortcut in between backticks (monospace formatting) +- Use uppercase letters with the abbreviated version of the key (`CTRL` instead of `CONTROL`, `CMD` instead of `COMMAND`for example) +- Wrap the complete keyboard shortcut in between backticks, including the plus sign: + - **Do**: + ```mdx + `CTRL + C` + ``` + + - **Don't**: + ```mdx + `CTRL` + `C` + ``` +- Do not use the old `` component \ No newline at end of file