v2.0.11

pardnchiu/NanoMD

最後更新

Note此 README 由 SKILL 生成,英文版請參閱 這裡。



FAST MARKDOWN TO AST AND HTML IN ONE PARSER!


npmDownloadsLicense


Available in the Chrome Web Store




TypeScript Markdown 解析器,具備 JSON AST、按需載入的 Mermaid/KaTeX/Chart.js 渲染與安全的 HTML 輸出

目錄



功能特點


npm i @pardnchiu/nanomd · 完整文件 · v1 停用說明 · 文件站

  • 單趟逐行解析 — 每行只掃描一次即建好整棵樹,4 MB 文件約 90 ms,比 v1 快 30 倍起,1 MB 文件差距超過 380 倍。
  • 與渲染無關的 AST — Parse() 回傳節點樹,json() 可複製成純資料,Web 與 SSR 直接用 html(),iOS、Flutter 等原生渲染可依同一份結果自行開發。
  • GFM 之外的擴充語法 — 註腳、參照式連結、GitHub 提示框、任務清單、行內與區塊數學式、圖片尺寸、影片嵌入與 #tag 連結皆內建。
  • 依賴按需載入並自動退回 — 只載入啟用的 Mermaid、KaTeX、Chart.js、prettify;語法錯誤的區塊自動改顯示為一般程式碼區塊。
  • 輸出即安全 — 文字與屬性在輸出時跳脫,raw HTML 移除危險標籤、事件屬性與 javascript: 網址。

效能比較


將文件站的文件頁合併成一份文件,重複放大到各尺寸後,在 macOS 的 headless Chrome 155 以 v1.11.6、v2 與 marked 18.1.1 量測轉成 HTML 的耗時。每個案例先暖機 5 次,再連續執行至少 1.5 秒取平均;單次超過 3 秒只量一次,超過 15 秒記為超時。並排渲染與瀏覽器現場測速見與 marked 比較。
文件大小v1.11.6 new MDParser().parse()v2 Parse().html()marked marked.parse()v1 / v2marked / v2
6.1 KB3.23 ms0.097 ms0.127 ms33×1.30×
42.2 KB26.9 ms0.87 ms1.08 ms31×1.24×
405.2 KB1,402 ms9.15 ms10.2 ms153×1.11×
1.00 MB8,853 ms23.1 ms26.3 ms383×1.14×
2.00 MB超時(超過 15 秒)44.6 ms53.9 ms超時1.21×
4.00 MB超時(超過 15 秒)88.3 ms101.7 ms超時1.15×

Chrome 擴充功能


Chrome 線上應用程式商店 · 使用說明 · 隱私權政策

在 Chrome 開啟本機 .md 或 .markdown 檔案,NanoMD 會以本解析器渲染:左側是原始碼編輯區,右側預覽隨輸入即時更新,Mermaid、KaTeX、Chart.js 與程式碼高亮皆打包在擴充功能內。按 Cmd/Ctrl + S 把編輯內容寫回選定的檔案,分頁標題出現 ● 表示尚未存檔。
ImportantChrome 預設不讓擴充功能存取 file:// 頁面。安裝後開啟 chrome://extensions,在 NanoMD 點 詳細資料,開啟 允許存取檔案網址;未開啟時檔案只會以純文字顯示。

NanoMD 擴充功能詳細資料中的「允許存取檔案網址」開關

架構


完整架構

graph LR
    Input[Markdown 文字] --> Block[區塊解析 ParseLines]
    Block --> Inline[行內解析 ParseInline]
    Inline --> Post[註腳與參照連結後處理]
    Post --> AST[AST]
    AST --> HTML["AST.html()"]
    AST --> JSON["AST.json()"]
    AST --> Native[原生渲染 iOS/Flutter(自行開發)]
    HTML --> 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 --> HTML["AST.html()"]
  7. AST --> JSON["AST.json()"]
  8. AST --> Native[原生渲染 iOS/Flutter(自行開發)]
  9. HTML --> Refresh["Refresh() 依賴渲染"]
  10. Init["Init() 載入依賴"] --> Refresh

授權


本專案採用 MIT LICENSE。

Author


Just open an issue to share an idea.
NanoMD contributors


©️ 2024 邱敬幃 Pardn Chiu
EN