Markdown (やその派生)のpre
要素になる記法では、問答無用にその中はcode
要素でマークアップされる。多くの場合はコードの断片なのでそれでいいんだけど、そうじゃないことももちろんある。例えばCLIプログラムでの操作手順を記載する時のターミナルの画面のコピー。
プログラムによる出力はsamp
要素で、キーボードによる入力はkbd
要素になるので、以下のようにマークアップするのがベストに近い。
<pre><samp>$ <kbd>node --help</kbd>
Usage: node [options] [ -e script | script.js ] [arguments]
node debug script.js [arguments]
Options:
...
NODE_DISABLE_COLORS Set to 1 to disable colors in the REPL
Documentation can be found at http://nodejs.org/
</samp></pre>
シェル・プログラムの出力である全体をまずsamp
要素でマークアップし、能動的にキー入力する部分はkbd
要素でマークアップする。出力のカラーやターミナルのプロンプトなどをそのままに色を付けたい場合は、span
要素に適当なclass
を振ってマークアップすれば良い。
過去ログのマークアップをこうなるように直してた。ちょくちょくsamp
要素は使ってたけど、kbd
要素は面倒がってまったく使ってなかった……。間違ったマークアップしてたよりはマシだったと思うことにしよう。