compile()

核心编译函数。使用原生 Rust 编译器将 Markdown 或 MDX 转换为 HTML 或其他输出格式。

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

签名

function compile(input: string, options?: CompileOptions): CompileResult

参数

input

属性类型默认值描述
inputstring—Markdown 或 MDX 源码字符串

options?

属性类型默认值描述
options?CompileOptions—包含插件在内的编译配置

返回值

属性类型描述
outputstring | object编译输出。默认是 HTML 字符串；HAST/MDAST 则为 JSON 字符串
frontmatterRecord<string, unknown>解析后的 frontmatter 元数据（无内容时为空 {}）
diagnosticsDiagnostic[]{ level, message, start?, end? } 数组
stats{ parseMs, transformMs, emitMs }各阶段耗时（毫秒）
tocTocEntry[]提取出的目录（若未启用 TOC 则为空 []）

用法

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

const md = `---
title: My Document
---

# Hello, **world**!

| Column A | Column B |
|----------|----------|
| Cell 1   | Cell 2   |
`;

const result = compile(md, {
  inputKind: "md",       // "md" | "mdx"
  outputKind: "html",    // "html" | "hast" | "mdast" | "mdxJs"
  plugins: [gfm(), frontmatter(), toc({ maxDepth: 3 }), sanitize()],
});

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

console.log(result.frontmatter);
// { title: "My Document" }

console.log(result.toc);
// [{ depth: 1, text: "Hello, world!", slug: "hello-world" }]

console.log(result.stats);
// { parseMs: 0.12, transformMs: 0.08, emitMs: 0.05 }

示例

基础 Markdown 转 HTML

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

const result = compile("# Hello, **world**!");

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

MDX 输入

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

const mdx = `
import { Alert } from "./components";

# Hello

<Alert type="info">This is MDX!</Alert>
`;

const result = compile(mdx, { inputKind: "mdx" });

输出 HAST

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

const result = compile("# Hello", { outputKind: "hast" });
const hast = JSON.parse(result.output as string);

console.log(hast);
// { type: "root", children: [{ type: "element", tagName: "h1", ... }] }

输出 MDAST

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

const result = compile("# Hello", { outputKind: "mdast" });
const mdast = JSON.parse(result.output as string);

console.log(mdast);
// { type: "root", children: [{ type: "heading", depth: 1, ... }] }

输出 MDX JS

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

const result = compile(mdxSource, {
  inputKind: "mdx",
  outputKind: "mdxJs",
});

console.log(result.output);
// JavaScript module string with MDX compiled to JSX