備忘録利用で kobito をよく利用しています。
bash コマンドを Markdown で記述する際に毎回悩んでいるので、調べた内容の備忘録を。
bash コマンドを記述する際のシンタックスタイプは以下の通りです。
- bash,sh,ksh
- shell-session
-
console(昔はあったようですが、補完に出てこないため廃止？)
各出力結果を見てみましょう。
none
# コメント
# echo hello
hello
$ echo hello
hello
test@test $ echo
test@test # echo
まずは参考までの none です。
bash
# コメント
# echo hello
hello
$ echo hello
hello
test@test $ echo
test@test # echo
次に bash です。コマンドは色づけしてくれるのですが、#～にすると～の部分が灰色となり見づらくなります。コメント部なので仕方ないのですが…
「$」や「#」は一般ユーザや特権ユーザ(root)を表す場合も多い為、#を先頭に記述する場合も多いと思います。
shell-session
# コメント
# echo hello
hello
$ echo hello
hello
test@test $ echo
test@test # echo
最後に shell-session です。こちらはコマンド出力結果を貼り付ける時に利用します。先頭をプロンプト(～@～ $ or #)形式で記述することで、その行だけ文字色が灰色にはならないようです。
結論
shell スクリプトを記述する ⇒ bash
コマンドの結果を貼り付ける ⇒ shell-session
コマンドの羅列 + コメント記載で利用している私は bash の「#」には妥協しようと思います…
(別のタイプを指定すれば綺麗に見えるのでしょうか…)
おまけ
指定無し
# コメント
# echo hello
hello
$ echo hello
hello
test@test $ echo
test@test # echo
「none」とはハイライトの仕方が違うようです。
私の利用用途では一番しっくりきているのですが、指定なしは何用のハイライトなんでしょう。
参考URL：Qiitaでシンタックスハイライト可能な言語一覧