シェルプロンプトのサンプルコードの作成ガイドライン

「シェル」とは何か

シェルとは、コマンドを入力してリターンキーが押すのを待つプログラムのことです。どのコマンドを入力すべきか示すために、 MDN 文書ではサンプルコードと同様のコードブロックにそれらをリストアップしています。ブロックは次のようなものです。

そんなブロックはこんな感じです。

# 時間が掛かるかもしれませんが・・・
git clone https://github.com/mdn/content
cd content

シェルプロンプトサンプルコードに関する一般的なガイドライン

書式の選択

正しいインデント、ホワイトスペース、行の長さに関する意見は常に論争の的となってきました。このようなトピックに関するディスカッションは、コンテンツを作成したり維持したりすることの妨げになります。

MDN Web Docs では、コードスタイルの一貫性を保つために（そしてトピック外の議論を避けるために）、コード整形ツールとして Prettier を使用しています。現在のルールについては設定ファイルを参照し、 Prettier のドキュメントを読んでください。

Prettier はすべてのコードを書式化し、スタイルの一貫性を保ちます。とはいえ、従わなければならない追加のルールがいくつかあります。

シェルのコードブロックを書く

シェルのコードブロックを書く場合、次のように書いてください。

• シェル命令の先頭に $ や > を入れないでください。これは混乱を招くだけでなく、命令をコピーする際にも使用できません。
• コメントは # で始めてください。
• 構文強調ツールは "bash" を選んでください。

関連情報

Django サーバーサイド開発ドキュメントでは、シェルプロンプトコマンドなどの MDN での良い実践的な表示を示しています。