Skip to content

Document keyboard symbol rendering in inline code #4574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Document keyboard symbol rendering in inline code #4574

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions create/code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```

#### Keyboard symbols

Inline code that contains keyboard symbols like `⌘`, `⌥`, `⇧`, `⌃`, or `↩` automatically renders with the surrounding text font instead of monospace. This makes keyboard shortcuts like `⌘C` or `⌥⇧P` blend naturally with surrounding text.

Check warning on line 21 in create/code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/code.mdx#L21 

Did you really mean 'monospace'?

Supported symbols include Command (`⌘`), Option/Alt (`⌥`), Shift (`⇧`), Control (`⌃`), Backspace (`⌫`), Return (`↩`), Enter (`↵`), and Tab (`⇥`).

```mdx
Press `⌘C` to copy or `⌥⇧P` to open the command palette.
```

### Code blocks

Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks. Code blocks are copyable, and if you have the assistant enabled, users can ask AI to explain the code.
Expand Down
Loading