Markdown 快速入門範本¶

簡介與快速入門¶

本文件旨在讓您盡快開始撰寫文件，即使您以前沒有 Markdown 經驗。目標是將處於「我想撰寫文件並將其添加到 LLVM 文件中」狀態的人，盡可能輕鬆地將其轉變為發送到 llvm-commits 的有用文件。

您可以在 docs/MarkdownQuickstartTemplate.md 中找到本文件。您應該複製它，在新文字編輯器中開啟檔案，撰寫您的文件，然後將新文件發送到 llvm-commits 進行審查。

專注於*內容*。如果需要，稍後很容易修復 Markdown 語法，儘管 Markdown 試圖模仿常見的純文字慣例，因此它應該非常自然。撰寫文件時，基本了解 Markdown 語法會很有幫助，因此本文件後半部分（從範例章節開始）提供的範例應涵蓋 99% 的使用案例。

讓我再說一次：專注於*內容*。但如果您真的需要驗證 Sphinx 的輸出，請參閱 docs/README.txt 以獲取資訊。

完成內容後，請將 .md 檔案發送到 llvm-commits 進行審查。

指導方針¶

嘗試在您的第一個章節中回答以下問題

為什麼我要閱讀本文檔？
我應該知道什麼才能理解本文檔？
在本文件結束時，我將學到什麼？

第一個章節的常見名稱是 簡介、概述 或 背景。

如果可能，請將您的文件命名為「how to」。將其命名為 HowTo*.md，就像其他「how to」文件一樣。這種格式通常是另一個人最容易理解的，也是最有用的。

除非您的主題已經有一個「how to」，否則您通常不應該撰寫「how to」以外的文件。這樣做的原因是，如果沒有先閱讀「how to」文件，人們就很難理解更進階的文件。

專注於內容（是的，我不得不再次強調）。

本文件的其餘部分顯示了 Markdown 標記構造範例，這些範例旨在讓您在將此檔案複製到新檔案中以供您撰寫文件後，在文字編輯器中閱讀。

範例章節¶

您的文字可以是*強調*、**粗體**或 等寬字體。

使用空行分隔段落。

標題（例如上方的 範例章節）為您的文件提供結構。

範例子章節¶

像這樣建立連結像這樣。還有一個更複雜的語法，對於較長的連結可以更易讀，因為它對流程的干擾較小。您可以將 [連結名稱]: <URL> 區塊放在文件中稍後的任何位置。

清單可以像這樣建立

以 [0-9]. 開頭的清單將會自動編號。
這是第二個清單元素。
1. 使用縮排建立巢狀清單。

您也可以使用非排序清單。

東西。
- 更深層的東西。
更多東西。

範例子子章節¶

您可以像這樣建立程式碼區塊

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 規範。Sphinx 特定的整合文件可以在 myst-parser 文件中找到。

產生文件¶

請參閱 [Sphinx 快速入門範本](project:SphinxQuickstartTemplate.rst#產生文件)

文件

參與

其他連結

本頁