解析流程
最後更新
本頁說明
Parse() 逐行判斷區塊的順序、行內解析如何遮罩內容,以及註腳與參照連結在最後如何解析。區塊判斷順序
ParseLines 由上往下讀每一行,依下表順序判斷,先命中者優先:| 順序 | 區塊 | 判斷依據 |
|---|---|---|
| 1 | 空行 | 只有空白;連續空行合併為一個 break |
| 2 | 程式碼區塊 | 3 個以上的 ` 或 ~ 開頭 |
| 3 | raw HTML | 以 HTML 標籤開頭的行 |
| 4 | 表格 | 含 | 且下一行是分隔列 |
| 5 | 水平線 | ***、---、___(可夾空白) |
| 6 | 引言 | > 開頭,含 GitHub 提示框 |
| 7 | 註腳定義 | [^id]:,只在最外層判斷 |
| 8 | 連結定義 | [label]: url "title",不輸出節點 |
| 9 | 清單 | -、*、1. 開頭 |
| 10 | 標題 | #~######,或 Setext 的 ===/--- |
| 11 | 一般段落 | 其餘;相鄰兩行合併為同一段,以 "\n" 文字節點連接 |
引言、清單項目與註腳的內容會再遞迴呼叫
ParseLines,所以裡面可以放任何區塊。行內解析
| 步驟 | 內容 |
|---|---|
| 1 | 先把整行的行內程式碼換成佔位符;內容是檔案路徑時轉成檔案連結 |
| 2 | 把行內數學式、跳脫字元換成佔位符 |
| 3 | 把註腳引用、連結、圖片、路徑、裸網址也換成佔位符 |
| 4 | 比對粗體、斜體、刪除線、標記、上下標 |
| 5 | 把佔位符還原成對應節點 |
佔位符讓連結裡的
_、* 不會被當成樣式,**[文字](網址)**、**粗體 `code`** 這類包住連結或程式碼的樣式也能正確解析。後處理
整份文件解析完後才處理需要全文資訊的節點:
| 項目 | 規則 |
|---|---|
| 註腳 | 依首次引用的順序編號,文末附上 footnotes 區塊;沒有定義的引用還原為 [^id] 文字 |
| 參照式連結 | 依連結定義(不分大小寫)換成 link 節點;沒有定義的還原為 [label][ref] 文字 |
- <div id="out" class="nanomd"></div>
- <script>
- const md = "First line\nsecond line\n\n\n\nSee [docs][d] and a note[^1].\n\n[d]: https://nanomd.pardn.io\n[^1]: Footnote text.";
- const ast = MDParser.Parse(md);
- console.log(ast.map((node) => node.type).join(", "));
- document.getElementById("out").innerHTML = ast.html();
- </script>