编写 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 提示命令的良好实践。