Markdownのコードブロックにおいてコマンドの出力が無い場合は$マークは必要ない

2023/07/05に公開
よくある間違い
$ ls
$ cat foo
$ less bar

Markdownのコードブロックにおいてシェルでのコマンド表記する場合、上記のように先頭に$記号を付けているケースが多い
しかし上記のようなケースでは$記号は記載することなく省略するべきとされている

正式な表記
ls
cat foo
less bar

しかし、以下のようにコマンドの出力も表記したい場合はコマンドと出力を区別するために$を付けると良い

出力との区別
$ ls
foo bar
$ cat foo
Hello world
$ cat bar
baz

参考

GitHubで編集を提案

Discussion