v2.0.11

快速開始

最後更新


本頁安裝 NanoMD,並在瀏覽器與 Node.js 把第一段 Markdown 轉成 HTML。

前置需求


項目需求
瀏覽器支援 ES2022、RegExp lookbehind 與 \p{L}:Chrome、Edge、Firefox、Safari 16.4+
Node.js22 以上(使用 ESM 或 require() 時)
網路啟用 Mermaid、KaTeX、Chart.js、code-prettify 時需連線至 cdn.jsdelivr.net,見 依賴與渲染

安裝


CDN


  1. <script src="https://cdn.jsdelivr.net/npm/@pardnchiu/nanomd@2.0.6/dist/parser.js"></script>

載入後提供全域 MDParser,並自動在 <head> 插入同目錄的 parser.css。

npm


  1. npm i @pardnchiu/nanomd

  1. import { MDParser } from "@pardnchiu/nanomd";

require("@pardnchiu/nanomd") 在 Node.js 22 也可使用。使用打包工具時若樣式沒有自動載入,再加上 import "@pardnchiu/nanomd/parser.css";。

第一次渲染


Parse() 回傳 AST,html() 把它轉成 HTML;輸出要放進 class="nanomd" 的容器才會套用樣式。
  1. <div id="preview" class="nanomd"></div>
  2. <script>
  3. const md = "# Hello\n\nThis is **NanoMD**.\n\n- [x] Parse\n- [ ] Render";
  4. document.getElementById("preview").innerHTML = MDParser.Parse(md).html();
  5. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

在 Node.js 輸出 HTML


Parse() 與 html() 不需要 DOM,可用於 SSR 或建置流程。
  1. import { MDParser } from "@pardnchiu/nanomd";
  2. const html = MDParser.Parse("## Title\n\n- [x] Done").html();
  3. console.log(html);

啟用圖表、數學式與上色


Init() 載入啟用的依賴,Refresh() 在已放進頁面的容器內渲染。依賴載入前,這些區塊顯示為一般程式碼區塊。
  1. <div id="out" class="nanomd"></div>
  2. <script>
  3. const md = "~~~math\nE = mc^2\n~~~\n\n~~~mermaid\nflowchart LR\n A[Markdown] --> B[AST] --> C[HTML]\n~~~";
  4. const out = document.getElementById("out");
  5. out.innerHTML = MDParser.Parse(md).html();
  6. MDParser.Init({ enable: { mermaid: true, latex: true } })
  7. .then(() => MDParser.Refresh(out))
  8. .then(() => console.log("rendered:", out.querySelectorAll("[data-rendered]").length))
  9. .catch((err) => console.error(err.message));
  10. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

下一步


想做的事頁面
了解支援的語法區塊語法、行內格式
拿 AST 自行渲染AST 節點
從 v1 升級v1 停用說明
EN