Use "kbd" tag for shortcuts in manual

[ghost]

Use <kbd>Key</kbd> tag for all shortcuts in manual instead?

• Now we has:

  New

  Ctrl+N

• Try:

  New

  Ctrl+N

  or

  New (Ctrl+N)

I use Ghostwriter text editor for Markdown files editing, that support many widely used rendering styles

• https://github.com/wereturtle/ghostwriter/releases/tag/v1.5.0

Here are variants (including current) for organize shortcuts in manual

Just don't know is it supported by all

• Github Flavoured Markdown
• Github Pages
• Doxygen Markdown

[ghost]

Here is my small "Markdown Shortcuts Cheat Sheet"

[dg0yt]

<kbd> doesn't not have a useful rendering in Qt Assistant.

Github's Markdown is of least relevance when it comes to documentation. We display the manual offline through facilities which are limited to a restricted subset of HTML 4.

[ghost]

At least, its much easier convert <kbd> to <cite> tag, supported by Qt Assistant for inline use

• Shortcut: <kbd>Ctrl</kbd>+<kbd>B</kbd> -- use for manual repository and online manual website;
• Shortcut: <cite>Ctrl</cite>+<cite>B</cite> -- use for packaged manual.

For the record

• https://meta.stackoverflow.com/questions/270967/proper-use-of-the-kbd-tag
• https://meta.stackexchange.com/questions/1939/kbd-elements-are-way-too-intrusive/

[ghost]

<kbd> doesn't not have a useful rendering in Qt Assistant.

It look like a bug of QtAssistant.

So, maybe, need to try fix default QtAssistant CSS for inbuilt <kbd>?

Try a look

• https://stackoverflow.com/questions/35407408/how-to-edit-qt-assistant-style-sheet
• https://meta.superuser.com/questions/4788/css-for-the-new-kbd-style