pardnchiu/NanoMD

Last updated 2026-10-20

NoteThis README was generated by SKILL, get the ZH version from here.

FAST MARKDOWN TO AST AND HTML IN ONE PARSER!

A TypeScript Markdown parser with a JSON AST, on-demand Mermaid/KaTeX/Chart.js rendering, and sanitized HTML output

Table of Contents

• Features
• v1 vs v2
• Architecture
• License
• Author

Features

npm i @pardnchiu/nanomd · Documentation · v1 Deprecation · Docs Site

• Single-Pass Line Parser — Each line is scanned once to build the whole tree; a 4 MB document renders in about 150 ms, at least 7 times faster than v1 and more than 230 times faster at 1 MB.
• Renderer-Agnostic AST — Parse() returns a node tree and json() copies it out as plain data; the web and SSR use html() directly, and native renderers for iOS or Flutter can be built on the same output.
• Extended Syntax Beyond GFM — Footnotes, reference links, GitHub alerts, task lists, inline and block math, image sizing, video embeds and #tag links are built in.
• On-Demand Dependencies with Fallbacks — Only the enabled Mermaid, KaTeX, Chart.js and prettify load, and invalid blocks fall back to plain code blocks.
• Safe by Default — Text and attributes are escaped at output, and raw HTML loses dangerous tags, event attributes and javascript: URLs.

v1 vs v2

Architecture

Full Architecture

graph LR
    Input[Markdown text] --> Block[Block parsing ParseLines]
    Block --> Inline[Inline parsing ParseInline]
    Inline --> Post[Footnote and link-ref post-processing]
    Post --> AST[AST]
    AST --> HTML["AST.html()"]
    AST --> JSON["AST.json()"]
    AST --> Native["Native rendering iOS/Flutter (build your own)"]
    HTML --> Refresh["Refresh() dependency rendering"]
    Init["Init() loads dependencies"] --> Refresh

graph LR
    Input[Markdown text] --> Block[Block parsing ParseLines]
    Block --> Inline[Inline parsing ParseInline]
    Inline --> Post[Footnote and link-ref post-processing]
    Post --> AST[AST]
    AST --> HTML["AST.html()"]
    AST --> JSON["AST.json()"]
    AST --> Native["Native rendering iOS/Flutter (build your own)"]
    HTML --> Refresh["Refresh() dependency rendering"]
    Init["Init() loads dependencies"] --> Refresh

License

Author