Shortcut
Styled keyboard shortcuts with physical keycap appearance. Auto-detects Mac vs Windows.
For isolated previews, theme switching, and sandbox editing, open the Shortcut playground on holydocs.com .
When to use
Use this component when you need stronger document structure, annotation, or narrative pacing inside a page.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
OS-Aware
Shows Mac or Windows shortcut based on user OS.
⌘+KCtrl+K⌘+K / Ctrl+Kmdx<Shortcut mac="⌘+K" win="Ctrl+K" />
Universal
Same shortcut on all platforms.
Ctrl+Shift+Pmdx<Shortcut keys="Ctrl+Shift+P" />
Props
| Prop | Type | Default | Description |
|---|---|---|---|
mac | string | -- | Mac shortcut (e.g. "⌘+K"). |
win | string | -- | Windows shortcut (e.g. "Ctrl+K"). |
keys | string | -- | Universal shortcut (no OS detection). |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<Shortcut mac="⌘+K" win="Ctrl+K" />
Tips
- Keep the surrounding copy short so the component remains the focal point instead of becoming redundant chrome.
- Prefer one clear job per component instance. If a block is trying to explain, navigate, and warn at the same time, split it up.
- Check the page in both light and dark mode when you stack multiple content components together. Dense compositions can feel heavier than expected.
Related Components
Callout
Highlighted message blocks for drawing attention to notes, tips, warnings, and other contextual information.
More
- Interactive playground: Shortcut on holydocs.com
- Component library index: /components