Keyboard Keys
Styled keyboard keys for documenting shortcuts and key combinations. Each key gets a raised appearance with a subtle border and shadow.
Single Key
EnterMARKDOWN
[doc-kbd key="Enter"]
Key Combinations
Separate keys with + to render compound shortcuts:
Press Ctrl+C to copy and Ctrl+V to paste.
MARKDOWN
Press [doc-kbd key="Ctrl+C"] to copy and [doc-kbd key="Ctrl+V"] to paste.
Multi-Key Shortcuts
Works with three or more keys:
Ctrl+Shift+P opens the command palette.
MARKDOWN
[doc-kbd key="Ctrl+Shift+P"] opens the command palette.
Mac Shortcuts
Use the standard Mac modifier symbols:
| Action | Shortcut |
|---|---|
| Save | ⌘+S |
| Undo | ⌘+Z |
| Find | ⌘+F |
| Select All | ⌘+A |
| Bold | ⌘+B |
| Command Palette | ⌘+⇧+P |
| Preferences | ⌘+, |
| Special Char | ⌥+⇧+8 |
| Spotlight | ⌘+Space |
MARKDOWN
| Action | Shortcut |
|----------------|----------|
| Save | [doc-kbd key="⌘+S"] |
| Undo | [doc-kbd key="⌘+Z"] |
| Command Palette | [doc-kbd key="⌘+��+P"] |
| Special Char | [doc-kbd key="⌥+��+8"] |
Available Mac symbols: ⌘ (Command), ⌥ (Option), ⇧ (Shift), ⌃ (Control), ⎋ (Escape)
Common Shortcuts
| Action | Windows/Linux | Mac |
|---|---|---|
| Save | Ctrl+S | ⌘+S |
| Undo | Ctrl+Z | ⌘+Z |
| Find | Ctrl+F | ⌘+F |
| Select All | Ctrl+A | ⌘+A |
MARKDOWN
| Action | Windows/Linux | Mac |
|--------|---------------|-----|
| Save | [doc-kbd key="Ctrl+S"] | [doc-kbd key="⌘+S"] |
| Undo | [doc-kbd key="Ctrl+Z"] | [doc-kbd key="⌘+Z"] |
Special Keys
Works with any key label:
Esc Tab Space Backspace Delete
MARKDOWN
[doc-kbd key="Esc"] [doc-kbd key="Tab"] [doc-kbd key="Space"] [doc-kbd key="Backspace"] [doc-kbd key="Delete"]
Arrow Keys
Up Down Left Right
MARKDOWN
[doc-kbd key="Up"] [doc-kbd key="Down"] [doc-kbd key="Left"] [doc-kbd key="Right"]
Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
key |
Yes | — | Key text, use + for combinations (e.g., Ctrl+Shift+P or ⌘+S) |