Github のドキュメントで キーボードショートカットを表示するよさげな方法
アプリケーションのドキュメントを書いているときに、キーボードショートカットを表示させたくなりますよね。 そこで、 Github でキーボードショートカットを入力するときにはどうやって書けばいいのか調べてみました。
Github では、 ドキュメントを書くときに、 Markdown を使うことができます。これは、
# タイトル
みたいな感じで文章の論理構造や簡単な装飾をテキストのみ(Not Binary File)ですることができるやつです。
まずは、 Github の Markdown の仕様から調べてみました。
以下の場所に置いてあります。
ぱっとみ、それらしきものは見つからないですね。。。
といういうことで、
HTML の埋め込み機能を使って、やっていきます。
具体的には、 <kbd></kbd>
のタグを使っていきます。
使用例
コピペのキーボードショートカットを示していきます。
<kbd><kbd>CTRL</kbd>+<kbd>C</kbd></kbd>