How to get nice formatting in my documentation

Hi there,

I have noticed that <kbd></kbd> is a popular HTML marker on the web for representing keystrokes, and that different websites use CSS to format them in different ways.

I would really like to use this in the documentation for my keyboard. I anticipate it to show up at:

• keyman.com/keyboards
• My KAB app
• PDF
• Another website (possibly)

I really like the formatting on this page:
Step 5: Rules with Context

In the documentation of the most poplar keyboards I have only been able to find this formatting, which is similar but not quite as easy to read:

https://help.keyman.com/keyboard/ekwtamil99uni/2.0.5/ekwtamil99uni

Peaking under the hood it looks like it was also implemented with a different strategy, not with <kbd> tags.

In yet another documentation which I looked up on GitHub, it looks like the formatting was done with markdown.

What is the best way to create nice formatting for keystrokes?

What markup language should I use as I write the documentation?

Thanks so much for your help!

3 posts - 2 participants

Read full topic