Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Reference

Keyboard shortcuts

Mark up key names and shortcuts inside documentation text.

Updated
Read as Markdown

Use <Kbd> to name a key or shortcut in a sentence. Include the action in the sentence; key styling alone does not explain what the shortcut does.

Syntax

Put each key in its own <Kbd> tag and write any separator as ordinary text.

Press <Kbd>⌘</Kbd> + <Kbd>C</Kbd> to copy selected text.

Press ⌘ + C to copy selected text.

<Kbd> takes nonempty plain text and no attributes. It works inside prose, headings, and table cells.

HTML, Markdown, and agents

HTML renders each key as a semantic <kbd> element. There is no interactive behavior or JavaScript requirement.

Markdown keeps the key names as ordinary text. An agent receives the same instruction and shortcut without interpreting the visual key style.

  • Short definitions — Use key styling for shortcuts and a disclosure for optional definitions.