v2.0.11

架構

最後更新


NanoMD 把解析與渲染拆成互不相依的層:解析只產生資料,HTML 輸出與依賴渲染是可選的下游。
其他 JavaScript Markdown 函式庫各有定位:marked 是講求速度的解析器與編譯器,markdown-it 完整支援 CommonMark 並以語法外掛擴充,markdown-exit 是 markdown-it 的 TypeScript 改寫,showdown 可在 Markdown 與 HTML 之間雙向轉換,remark 是 unified 生態系中以外掛組成的處理器,micromark 是小巧且符合 CommonMark 的解析器;它們都透過外掛或擴充支援核心 Markdown 以外的語法。NanoMD 的做法不同:一次 Parse() 取得 AST,可用 json() 序列化成 JSON、用 html() 輸出經過跳脫與清理的 HTML;Mermaid 圖表、KaTeX 數學式與 Chart.js 圖表是內建語法,只有在 Init() 啟用時才從 CDN 載入對應函式庫。

系統概覽


graph LR
    Input[Markdown 文字] --> Block[區塊解析 ParseLines]
    Block --> Inline[行內解析 ParseInline]
    Inline --> Post[註腳與參照連結後處理]
    Post --> AST[AST]
    AST --> JSON["AST.json()(原生渲染自行開發)"]
    AST --> HTML["AST.html()"]
    HTML --> DOM[.nanomd 容器]
    DOM --> Refresh["Refresh() 依賴渲染"]
    Init["Init() 載入依賴"] --> Refresh
  1. graph LR
  2. Input[Markdown 文字] --> Block[區塊解析 ParseLines]
  3. Block --> Inline[行內解析 ParseInline]
  4. Inline --> Post[註腳與參照連結後處理]
  5. Post --> AST[AST]
  6. AST --> JSON["AST.json()(原生渲染自行開發)"]
  7. AST --> HTML["AST.html()"]
  8. HTML --> DOM[.nanomd 容器]
  9. DOM --> Refresh["Refresh() 依賴渲染"]
  10. Init["Init() 載入依賴"] --> Refresh

分層


層原始碼職責需要 DOM
區塊解析src/parser/index.ts、blockquote.ts、codeBlock.ts、heading.ts、list.ts、tableBlock.ts、footnote.ts逐行判斷區塊類型,產生 BlockNode否
行內解析src/parser/inline.ts、link.ts程式碼、數學式、連結、樣式等行內節點否
後處理footnote.ts、link.ts註腳編號、參照式連結還原否
HTML 輸出src/parser/html.tsAST.html()、跳脫與 raw HTML 清洗否
執行期src/parser/refresh.ts、index.ts 的 Init()載入依賴、渲染圖表/數學式/流程圖、綁定複製與檔案連結是
樣式src/sass/parser.scss.nanomd 容器樣式,編譯為 parser.css—

設計原則


原則說明
資料與渲染分離Parse() 只回傳節點樹,json() 可複製成純資料交給 Web 以外的渲染器
單趟逐行每行只判斷一次,耗時與文件大小成線性關係
跳脫在輸出時進行AST 保留原文,html() 才跳脫文字與屬性
依賴不自動載入Mermaid、KaTeX、Chart.js、prettify 只在 Init() 啟用時才載入
失敗退回程式碼依賴未載入或語法錯誤時,區塊維持顯示一般程式碼區塊

模組級的完整圖表見 doc/architecture.zh.md;解析順序見 解析流程。
  1. <script>
  2. const ast = MDParser.Parse("# Title\n\nText with **bold**.");
  3. console.log(ast.map((node) => node.type).join(" -> "));
  4. console.log(ast.html());
  5. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11
EN