Markdown 書寫規範

许久不见發表於2024-10-11

Markdown 書寫規範

  本文有助於您規範使用 Markdown 語法規則,使您的文件更容易理解。雖然不是必需的,但很快您就會發現,這些規則很好的相容了各種 Markdown 編輯器,能夠準確地為您呈現文件內容。

標題

  • 整篇文件只能有一個頂級標題,並且要放在文件首行;
  • 標題符號要從行首開始,位於塊引用和程式碼塊中的標題符號除外;
  • 標題符號和標題文字之間要留出空格,並且只能有一個空格;
  • 標題相鄰的上、下行要留出空行,位於文件首行和末行時除外;
  • 標題等級每次只能增加一個級別,不要越級使用;
  • 標題行行尾不要使用中、英文標點符號,包括:逗號、句號、分號、冒號和感嘆號;
  • 整篇文件不能有內容相同的標題行;
  • 整篇文件要使用統一的標題符號。

無序列表

  • 無序列表相鄰的上、下行要留出空行,位於文件首行和末行時除外;
  • 無序列表符號與列表內容之間要留出一個空格;
  • 無序列表子項符號始終縮排兩個空格;
  • 同級別無序列表符號的縮排始終保持一致;
  • 整篇文件要使用統一的無序列表符號。

有序列表

  • 有序列表相鄰的上、下行要留出空行,位於文件首行和末行時除外;
  • 有序列表項要從 "0." 或 "1." 開始,並且始終按照數字順序增加序號;
  • 有序列表符號與列表內容之間要留出一個空格;
  • 同級別有序列表符號的縮排始終保持一致。

表格

  • 表格每行開頭和結尾都要放置一個管道符;
  • 表格每行單元格的數量必須保持一致;
  • 表格相鄰的上、下行都要留出空行,位於文件首行和末行時除外。

塊引用

  • 塊引用符號和內容之間要留出空格,並且只能有一個空格;
  • 塊引用行間不能有空行,但允許在空行前新增一個塊引用符號。

程式碼和程式碼塊

  • 程式碼符號與文字之間不能有空格;
  • 程式碼塊要指定內部的編碼語言;
  • 程式碼塊相鄰的上、下行要留出空行,位於文件首行和末行時除外;
  • 程式碼塊中的命令列應省略行首的美元符號,但有輸出行時除外;
  • 整篇文件使用統一的程式碼塊格式(使用縮排或者使用符號);
  • 整篇文件使用統一的程式碼塊符號(波浪號或者反引號)。

粗體和斜體

  • 不要使用整行粗體或者整行斜體文字代替標題;
  • 粗體、斜體符號與文字之間不能有空格;
  • 整篇文件要使用統一的粗體和斜體符號。

URL 和 email

  • URL 地址或者錨點不能是空的;
  • URL 文字和地址的語法順序不能顛倒;
  • 自動連結的 URL 和 email 要放入一對尖括號中;
  • 自動連結的 URL 和 email 與尖括號之間不能有空格;
  • 自動連結的 URL 和 email 可以包裝成 程式碼 來禁止跳轉。

圖片

  • 應該為圖片提供替代文字,當圖片載入失敗時顯示這個文字。

分隔符

  • 整篇文件應使用統一樣式的水平分割符。

通用

  • 不要在行末尾隨無效空格,用作斷行的空格除外;
  • 不要使用製表符縮排,而應該使用空格縮排;
  • 不要在段落間出現連續空行,位於程式碼塊中時除外;
  • 不要在單行中超過最大字元數限制(預設 80),URL 除外;
  • 不要在文件中使用內聯 HTML 元素,必要時除外;
  • 應該使用正確的大小寫書寫專有名稱;
  • 應該使用換行符另起新行結束整篇文件。

相關文章