{
  "url": "https://unifast.dev/zh-CN/docs/packages/core/overview/",
  "locale": "zh-CN",
  "title": "@unifast/core",
  "description": "unifast 各运行时包共享的 TypeScript 类型定义、HAST 工具函数和错误类。",
  "section": "packages",
  "body": "## 概述\n\n`@unifast/core` 提供了共享的 TypeScript 类型定义，涵盖编译选项、编译结果、HAST（HTML 抽象语法树）节点、插件接口以及错误类。它是 `@unifast/node` 等运行时包的依赖 —— 通常**无需**直接安装。\n\n要使用编译器和内置插件，请使用 [`@unifast/node`](/docs/packages/node/overview)。\n\n## 安装\n\n## 类型定义\n\n### CompileOptions\n\n`compile()` 函数的配置。\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `inputKind` | `\"md\" \\| \"mdx\"` | `\"md\"` | 输入格式 |\n| `outputKind` | `\"html\" \\| \"hast\" \\| \"mdast\" \\| \"mdxJs\"` | `\"html\"` | 输出格式 |\n| `gfm` | `object` | - | GitHub Flavored Markdown 相关设置 |\n| `gfm.tables` | `boolean` | - | 启用 GFM 表格 |\n| `gfm.taskList` | `boolean` | - | 启用任务列表复选框 |\n| `gfm.strikethrough` | `boolean` | - | 启用 `~~strikethrough~~` |\n| `gfm.footnotes` | `boolean` | - | 启用脚注 |\n| `gfm.autolink` | `boolean` | - | 启用 URL 自动链接 |\n| `frontmatter` | `object` | - | Frontmatter 解析设置 |\n| `frontmatter.yaml` | `boolean` | - | 解析 YAML frontmatter |\n| `frontmatter.toml` | `boolean` | - | 解析 TOML frontmatter |\n| `frontmatter.json` | `boolean` | - | 解析 JSON frontmatter |\n| `rawHtml` | `\"disallow\" \\| \"allowDangerous\" \\| \"parseAndSanitize\"` | - | 控制源码中原始 HTML 的处理方式 |\n| `sanitize` | `object` | - | HTML 净化设置 |\n| `sanitize.enabled` | `boolean` | - | 启用净化 |\n| `sanitize.schema` | `SanitizeSchema` | - | 自定义净化规则 |\n| `highlight` | `object` | - | 语法高亮设置 |\n| `highlight.enabled` | `boolean` | - | 启用语法高亮 |\n| `highlight.engine` | `\"none\" \\| \"syntect\" \\| \"treeSitter\"` | - | 高亮引擎 |\n| `slug` | `object` | - | 标题 slug 生成设置 |\n| `slug.mode` | `\"github\" \\| \"unicode\"` | - | slug 生成算法 |\n| `toc` | `object` | - | 目录设置 |\n| `toc.enabled` | `boolean` | - | 启用目录提取 |\n| `toc.maxDepth` | `number` | - | 要包含的最大标题层级 |\n| `diagnostics` | `object` | - | 诊断输出设置 |\n| `diagnostics.format` | `\"compact\" \\| \"verbose\"` | - | 诊断格式 |\n| `cache` | `object` | - | 缓存设置 |\n| `cache.enabled` | `boolean` | - | 启用结果缓存 |\n| `cache.dir` | `string` | - | 缓存目录路径 |\n| `plugins` | `UnifastPlugin[]` | `[]` | 要应用的插件数组 |\n\n### CompileResult\n\n由 `compile()` 函数返回。\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `output` | `string \\| object` | 编译输出（根据 `outputKind` 可能是 HTML 字符串、HAST JSON 或 MDAST JSON） |\n| `frontmatter` | `Record<string, unknown>` | 解析后的 frontmatter 元数据 |\n| `diagnostics` | `Diagnostic[]` | 警告和错误的数组 |\n| `stats` | `{ parseMs, transformMs, emitMs }` | 各阶段耗时（毫秒） |\n| `toc` | `TocEntry[]` | 提取出的目录条目 |\n\n### Diagnostic\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `level` | `\"error\" \\| \"warn\"` | 严重级别 |\n| `message` | `string` | 面向人类阅读的消息 |\n| `start` | `number \\| undefined` | 源码中的起始字节偏移 |\n| `end` | `number \\| undefined` | 源码中的结束字节偏移 |\n| `line` | `number \\| undefined` | 行号（从 1 开始） |\n| `column` | `number \\| undefined` | 列号（从 1 开始） |\n\n### TocEntry\n\n从目录中提取出的单条标题记录。\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `depth` | `number` | 标题层级（1-6） |\n| `text` | `string` | 标题的纯文本内容 |\n| `slug` | `string` | 用于锚点链接的 slug |\n\n### SanitizeSchema\n\n自定义净化规则。\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `allowedTags` | `string[]` | 允许的 HTML 标签 |\n| `allowedAttributes` | `Record<string, string[]>` | 每个标签允许的属性 |\n| `allowedProtocols` | `Record<string, string[]>` | 每个属性允许的 URL 协议 |\n\n### UnifastPlugin\n\n用于扩展 unifast 的插件接口。\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `name` | `string` | 插件的唯一名称 |\n| `options?` | `Partial<CompileOptions>` | 要合并到编译选项中的配置 |\n| `hastTransform?` | `(hast: HastRoot) => HastRoot` | 在编译后转换 HAST 树 |\n\n### HAST 节点类型\n\n| 类型 | `type` 字段 | 属性 | 描述 |\n|------|-------------|------------|-------------|\n| `HastRoot` | `\"root\"` | `children: HastNode[]` | 树的根节点 |\n| `HastElement` | `\"element\"` | `tagName`、`properties`、`children` | 一个 HTML 元素 |\n| `HastText` | `\"text\"` | `value: string` | 一个文本节点 |\n| `HastRaw` | `\"raw\"` | `value: string` | 原样透传的 HTML |\n| `HastComment` | `\"comment\"` | `value: string` | 一条 HTML 注释 |\n| `HastDoctype` | `\"doctype\"` | - | 一个 `<!DOCTYPE html>` 节点 |\n\n`HastNode` 是联合类型：`HastRoot | HastElement | HastText | HastRaw | HastComment | HastDoctype`\n\n## 错误类\n\n| 类 | 继承自 | 属性 | 描述 |\n|-------|---------|------------|-------------|\n| `UnifastError` | `Error` | `code?: string`、`span?: { start, end }` | unifast 所有错误的基类 |\n| `ParseError` | `UnifastError` | `code: \"PARSE_ERROR\"` | 当 Markdown/MDX 输入无法解析时抛出 |\n| `CompileError` | `UnifastError` | `code: \"COMPILE_ERROR\"` | 当解析后编译失败时抛出 |\n\n```ts\n\ntry {\n  // ... compile something\n} catch (err) {\n  if (err instanceof ParseError) {\n    console.error(`Parse error at ${err.span?.start}: ${err.message}`);\n  } else if (err instanceof CompileError) {\n    console.error(`Compile error: ${err.message}`);\n  }\n}\n```\n\n## 导出列表\n\n| 导出 | 类别 | 描述 |\n|--------|------|-------------|\n| `CompileOptions` | type | 编译配置 |\n| `CompileResult` | type | 编译结果 |\n| `TocEntry` | type | 目录条目 |\n| `SanitizeSchema` | type | 净化规则 |\n| `UnifastPlugin` | type | 插件接口 |\n| `HastNode` | type | 所有 HAST 节点类型的联合 |\n| `HastRoot` | type | HAST 根节点 |\n| `HastElement` | type | HAST 元素节点 |\n| `HastText` | type | HAST 文本节点 |\n| `HastRaw` | type | HAST 原始 HTML 节点 |\n| `HastComment` | type | HAST 注释节点 |\n| `HastDoctype` | type | HAST doctype 节点 |\n| `hastToHtml` | function | HAST 到 HTML 的序列化函数 |\n| `escapeHtml` | function | 转义 HTML 特殊字符（`&`、`<`、`>`、`\"`） |\n| `extractLang` | function | 从 HAST `<code>` 元素中提取语言标识 |\n| `extractText` | function | 从 HAST 节点中提取纯文本内容 |\n| `findCodeChild` | function | 查找 `<pre>` 元素内的 `<code>` 子元素 |\n| `visitHast` | function | 用于遍历 HAST 树的访问者工具 |\n| `UnifastError` | class | 错误基类 |\n| `ParseError` | class | 解析错误类 |\n| `CompileError` | class | 编译错误类 |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/docs/packages/core/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/core/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/core/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/core/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/core/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/core/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/core/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/core/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/core/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/core/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/core/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/core/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/core/overview.json"
    }
  ]
}