編寫 Shell 提示程式碼示例的指南
以下指南涵蓋了如何為 MDN Web Docs 編寫 Shell 提示程式碼示例。
什麼是“Shell”？
Shell 是一種程式，它等待您鍵入命令然後按回車鍵。為了指示您應該鍵入哪些命令，MDN Web Docs 上的內容會將它們列在程式碼塊中，類似於程式碼示例。
這樣的程式碼塊看起來是這樣的
bash
# This may take a while...
git clone https://github.com/mdn/content
cd content
Shell 提示程式碼示例通用指南
選擇格式
關於正確縮排、空格和行長度的看法一直備受爭議。關於這些話題的討論會分散建立和維護內容的注意力。
在 MDN Web 文件中，我們使用 Prettier 作為程式碼格式化程式，以保持程式碼風格一致（並避免離題討論）。您可以查閱我們的 配置檔案 以瞭解當前規則，並閱讀 Prettier 文件。
Prettier 格式化所有程式碼並保持風格一致。然而，還有一些額外的規則需要您遵循。
編寫 Shell 程式碼塊
編寫 Shell 程式碼塊時
- 不要在 Shell 指令的開頭包含
$或>。這會比幫助帶來更多困惑，並且在複製指令時沒有用。 - 註釋以
#開頭。 - 在 Markdown 中選擇 "bash" 來指示語言。
另見
Django 伺服器端開發文件 展示了 Shell 提示命令的良好實踐。