{
  "url": "https://unifast.dev/zh-CN/docs/packages/node/overview/",
  "locale": "zh-CN",
  "title": "@unifast/node",
  "description": "基于原生 Rust 的 unifast Markdown/MDX 编译器的 Node.js 绑定。",
  "section": "packages",
  "body": "## 概述\n\n`@unifast/node` 是在 Node.js 中使用 unifast 的主要入口。它提供了 [`compile()`](/docs/packages/node/compile) 函数，通过 napi-rs 调用原生 Rust 编译器，以获得最佳性能。它同时支持插件系统，允许在 Rust 编译阶段之后在 JavaScript 中应用 HAST 转换。\n\n## 安装\n\n> 原生 Rust 扩展必须预先构建。如果原生二进制文件不可用，请运行 `cargo build -p unifast-bindings-node --release`。\n\n## 快速开始\n\n```ts\n\nconst result = compile(\"# Hello, **world**!\");\nconsole.log(result.output);\n// <h1 id=\"hello-world\">Hello, <strong>world</strong>!</h1>\n```\n\n## 插件流水线\n\n当传入插件时，`compile()` 会按以下流程执行：\n\n1. **抽离插件** —— 将 `plugins` 与其他选项分开\n2. **合并选项** —— 深度合并每个插件的 `options` 到编译选项中\n3. **强制 HAST** —— 只要有任一插件带有 `hastTransform`，原生调用就会使用 `outputKind: \"hast\"`\n4. **原生编译** —— 通过 napi-rs 调用 Rust 编译器\n5. **HAST 转换** —— 按顺序应用每个插件的 `hastTransform`\n6. **转换输出** —— 如果用户没有请求 HAST 输出，则通过 `hastToHtml` 转换回 HTML\n\n## 内置插件\n\n包中已内置以下插件工厂函数 —— 无需单独安装：\n\n`gfm`、`frontmatter`、`sanitize`、`syntect`、`treeSitter`、`toc`、`externalLinks`、`autolinkHeadings`、`smartypants`、`wikiLink`、`codeImport`、`emoji`、`breaks`、`math`、`githubAlert`、`sectionize`、`directive`、`definitionList`、`rubyAnnotation`、`cjk`\n\n```ts\n\nconst result = compile(source, {\n  plugins: [gfm(), frontmatter(), syntect()],\n});\n```\n\n## 导出列表\n\n| 导出 | 类别 | 描述 |\n|--------|------|-------------|\n| `compile` | function | 将 Markdown/MDX 编译为 HTML 或其他格式 |\n| `gfm`、`frontmatter`、... | function | 内置插件工厂（共 20 个） |\n| `hastToHtml` | function | HAST 到 HTML 的序列化函数（从 `@unifast/core` 重新导出） |\n| `CompileOptions` | type | 编译配置 |\n| `CompileResult` | type | 编译结果 |\n| `UnifastPlugin` | type | 插件接口 |\n| `TocEntry` | type | 目录条目 |\n| `HastRoot` | type | HAST 根节点 |\n| `HastElement` | type | HAST 元素节点 |\n| `HastText` | type | HAST 文本节点 |\n| `HastNode` | type | 所有 HAST 节点类型的联合 |\n| `UnifastError` | class | 错误基类 |\n| `ParseError` | class | 解析错误类 |\n| `CompileError` | class | 编译错误类 |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/docs/packages/node/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/node/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/node/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/node/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/node/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/overview.json"
    }
  ]
}