编写 shell 命令行代码示例的指南

Shell 是一个等待您输入命令并按回车键的程序。为了指示您应该输入哪些命令，MDN Web 文档上的内容将它们列在代码块中，类似于代码示例。

这样的代码块看起来像这样

# This may take a while...
git clone https://github.com/mdn/content
cd content

关于正确缩进、空格和行长的观点一直存在争议。关于这些主题的讨论会分散创建和维护内容的注意力。

在 MDN Web 文档中，我们使用 Prettier 作为代码格式化程序，以保持代码风格一致（并避免无关紧要的讨论）。您可以参考我们的 配置文件 来了解当前规则，并阅读 Prettier 文档。

Prettier 格式化所有代码并保持风格一致。然而，您还需要遵循一些额外的规则。

编写 shell 代码块时

• 不要在 shell 指令的开头包含 $ 或 >。它会造成更多混乱，而不是帮助，而且在复制指令时没有用。
• 注释以 # 开头。
• 在 markdown 中选择“bash”来指示语言。

Django 服务器端开发文档 展示了 shell 命令行命令的良好实践演示。