{
  "url": "https://unifast.dev/zh-TW/docs/packages/node/compile/",
  "locale": "zh-TW",
  "title": "compile()",
  "description": "主要的編譯函式。使用原生 Rust 編譯器將 Markdown 或 MDX 轉換為 HTML 或其他輸出格式。",
  "section": "packages",
  "body": "```ts\n\n```\n\n## 函式簽名\n\n```ts\nfunction compile(input: string, options?: CompileOptions): CompileResult\n```\n\n## 參數\n\n### input\n\n| 屬性 | 型別 | 預設值 | 說明 |\n|----------|------|---------|-------------|\n| `input` | `string` | — | Markdown 或 MDX 原始碼字串 |\n\n### options?\n\n| 屬性 | 型別 | 預設值 | 說明 |\n|----------|------|---------|-------------|\n| `options?` | `CompileOptions` | — | 包含外掛在內的編譯設定 |\n\n## 回傳值\n\n| 屬性 | 型別 | 說明 |\n|----------|------|-------------|\n| `output` | `string \\| object` | 編譯後的輸出。預設為 HTML 字串；HAST/MDAST 時則為 JSON 字串。 |\n| `frontmatter` | `Record<string, unknown>` | 已解析的 frontmatter 後設資料（若無則為空的 `{}`） |\n| `diagnostics` | `Diagnostic[]` | `{ level, message, start?, end? }` 陣列 |\n| `stats` | `{ parseMs, transformMs, emitMs }` | 各階段耗時（毫秒） |\n| `toc` | `TocEntry[]` | 擷取而得的目錄（停用 TOC 時為空的 `[]`） |\n\n## 用法\n\n```ts\n\nconst md = `---\ntitle: My Document\n---\n\n# Hello, **world**!\n\n| Column A | Column B |\n|----------|----------|\n| Cell 1   | Cell 2   |\n`;\n\nconst result = compile(md, {\n  inputKind: \"md\",       // \"md\" | \"mdx\"\n  outputKind: \"html\",    // \"html\" | \"hast\" | \"mdast\" | \"mdxJs\"\n  plugins: [gfm(), frontmatter(), toc({ maxDepth: 3 }), sanitize()],\n});\n\nconsole.log(result.output);\n// <h1 id=\"hello-world\">Hello, <strong>world</strong>!</h1>\n// <table>...</table>\n\nconsole.log(result.frontmatter);\n// { title: \"My Document\" }\n\nconsole.log(result.toc);\n// [{ depth: 1, text: \"Hello, world!\", slug: \"hello-world\" }]\n\nconsole.log(result.stats);\n// { parseMs: 0.12, transformMs: 0.08, emitMs: 0.05 }\n```\n\n## 範例\n\n### 基本的 Markdown 轉 HTML\n\n```ts\n\nconst result = compile(\"# Hello, **world**!\");\n\nconsole.log(result.output);\n// <h1 id=\"hello-world\">Hello, <strong>world</strong>!</h1>\n```\n\n### MDX 輸入\n\n```ts\n\nconst mdx = `\n\n# Hello\n\n`;\n\nconst result = compile(mdx, { inputKind: \"mdx\" });\n```\n\n### HAST 輸出\n\n```ts\n\nconst result = compile(\"# Hello\", { outputKind: \"hast\" });\nconst hast = JSON.parse(result.output as string);\n\nconsole.log(hast);\n// { type: \"root\", children: [{ type: \"element\", tagName: \"h1\", ... }] }\n```\n\n### MDAST 輸出\n\n```ts\n\nconst result = compile(\"# Hello\", { outputKind: \"mdast\" });\nconst mdast = JSON.parse(result.output as string);\n\nconsole.log(mdast);\n// { type: \"root\", children: [{ type: \"heading\", depth: 1, ... }] }\n```\n\n### MDX JS 輸出\n\n```ts\n\nconst result = compile(mdxSource, {\n  inputKind: \"mdx\",\n  outputKind: \"mdxJs\",\n});\n\nconsole.log(result.output);\n// JavaScript module string with MDX compiled to JSX\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/docs/packages/node/compile.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/compile.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/compile.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/compile.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/compile.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/compile.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/it/docs/packages/node/compile.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/es/docs/packages/node/compile.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/compile.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/de/docs/packages/node/compile.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/compile.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/compile.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/id/docs/packages/node/compile.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/compile.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/compile/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/compile.json"
    }
  ]
}