Markdown 快速入门模板¶
简介和快速入门¶
本文档旨在帮助您尽快开始编写文档，即使您之前没有 Markdown 经验。目标是将“我想编写文档并将其添加到 LLVM 的文档中”的状态转变为有用的文档，并尽可能减少麻烦，然后发送到 llvm-commits 进行审核。
您可以在 docs/MarkdownQuickstartTemplate.md 中找到此文档。您应该复制它，在文本编辑器中打开新文件，编写您的文档，然后将新文档发送到 llvm-commits 以供审核。
专注于内容。如有必要，稍后可以轻松修复 Markdown 语法，尽管 Markdown 试图模仿常见的纯文本约定，因此它应该非常自然。在编写文档时，了解 Markdown 语法的基本知识非常有用，因此本文档的后半部分（从 示例部分 开始）提供了涵盖 99% 用例的示例。
再说一遍：专注于内容。但是，如果您确实需要验证 Sphinx 的输出，请参阅 docs/README.txt 获取信息。
完成内容后，请将 .md 文件发送到 llvm-commits 以供审核。
指南¶
尝试在您的第一部分回答以下问题
为什么我想阅读本文档？
我需要具备哪些知识才能理解本文档？
阅读完本文档后，我将学到什么？
第一部分的常见名称是 Introduction、Overview 或 Background。
如果可能，请将您的文档制作成“操作指南”。将其命名为 HowTo*.md，就像其他“操作指南”文档一样。这种格式通常最容易被人理解，也是最有用的。
通常，您不应该编写除了“操作指南”之外的文档，除非您的主题已经有“操作指南”。这样做的原因是，如果没有“操作指南”文档供先阅读，人们就很难理解更高级的文档。
专注于内容（是的，我必须再说一遍）。
本文档的其余部分显示了示例 Markdown 标记结构，您应该在复制此文件到您即将编写的文档的新文件中后，在您的文本编辑器中阅读这些结构。
示例部分¶
您的文本可以强调、加粗或等宽字体。
使用空行分隔段落。
标题（如上面的 Example Section）为您的文档提供结构。
示例子部分¶
创建链接如下所示。还有一种更复杂的语法可能更易于阅读，因为对于较长的链接，它会减少中断流程。您可以在文档中稍后的任何位置放置 [link name]: <URL> 块。
列表可以这样创建
以
[0-9].开头的列表将自动编号。这是第二个列表元素。
使用缩进创建嵌套列表。
您还可以使用无序列表。
内容。
更深层的内容。
更多内容。
示例子子部分¶
您可以像这样创建代码块
int main() {
return 0;
}
作为 Markdown 的扩展，您还可以指定要使用的突出显示器。
int main() {
return 0;
}
对于 shell 会话，请使用 console 代码块。
$ echo "Goodbye cruel world!"
$ rm -rf /
如果您需要显示 LLVM IR，请使用 llvm 代码块。
define i32 @test1() {
entry:
ret i32 0
}
您可能需要的一些其他常见代码块包括 c、objc、make 和 cmake。如果您需要超出这些范围的内容，可以查看支持的代码块的完整列表。
但是，当您可以添加有意义的内容时，不要浪费时间调整语法高亮。如有疑问，请像这样显示预格式化的文本，无需任何语法高亮
.
+:.
..:: ::
.++:+:: ::+:.:.
.:+ :
::.::..:: .+.
..:+ :: :
......+:. ..
:++. .. :
.+:::+:: :
.. . .+ ::
+.: .::+.
...+. .: .
.++:..
...
希望您不需要深入到这种程度¶
如果您需要执行本文档中所示内容之外的更复杂的操作，您可以发送邮件到列表或查看Common Mark 规范。可以在 myst-parser 文档 中找到 Sphinx 特定的集成文档。
生成文档¶
请参阅 [Sphinx 快速入门模板](project:SphinxQuickstartTemplate.rst#Generating the documentation)