@unifast/node

概觀

@unifast/node 是在 Node.js 中使用 unifast 的主要進入點。它提供 compile() 函式，透過 napi-rs 呼叫原生 Rust 編譯器以達成最佳效能。它也支援外掛系統，允許在 Rust 編譯步驟完成後，以 JavaScript 套用 HAST 轉換。

安裝

原生 Rust 附加套件必須事先建置完成。若尚未備妥原生二進位檔，請執行 cargo build -p unifast-bindings-node --release。

快速開始

import { compile } from "@unifast/node";

const result = compile("# Hello, **world**!");
console.log(result.output);
// <h1 id="hello-world">Hello, <strong>world</strong>!</h1>

外掛管線

當提供外掛時，compile() 會執行以下管線：

1. 擷取外掛 - 將 plugins 與其餘選項分開

2. 合併選項 - 將每個外掛的 options 以深層合併方式併入 compile 選項

3. 強制使用 HAST - 若有任何外掛具備 hastTransform，原生呼叫會改用 outputKind: "hast"

4. 原生編譯 - 透過 napi-rs 呼叫 Rust 編譯器

5. 套用 HAST 轉換 - 依序執行每個外掛的 hastTransform

6. 轉換輸出 - 若使用者未要求 HAST 輸出，透過 hastToHtml 轉回 HTML

內建外掛

下列外掛工廠函式皆已內建，不需另外安裝：

gfm、frontmatter、sanitize、syntect、treeSitter、toc、externalLinks、autolinkHeadings、smartypants、wikiLink、codeImport、emoji、breaks、math、githubAlert、sectionize、directive、definitionList、rubyAnnotation、cjk

import { compile, gfm, frontmatter, syntect } from "@unifast/node";

const result = compile(source, {
  plugins: [gfm(), frontmatter(), syntect()],
});

匯出列表