compile()

Die primäre Kompilierungsfunktion. Wandelt Markdown oder MDX mithilfe des nativen Rust-Compilers in HTML oder andere Ausgabeformate um.

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

Signatur

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

Parameter

input

EigenschaftTypStandardBeschreibung
inputstring—Markdown- oder MDX-Quellstring

options?

EigenschaftTypStandardBeschreibung
options?CompileOptions—Kompilierungskonfiguration einschließlich Plugins

Rückgabewert

EigenschaftTypBeschreibung
outputstring | objectKompilierte Ausgabe. Standardmäßig HTML-String; JSON-String für HAST/MDAST.
frontmatterRecord<string, unknown>Geparste Frontmatter-Metadaten (leer {}, falls keine vorhanden)
diagnosticsDiagnostic[]Array von { level, message, start?, end? }
stats{ parseMs, transformMs, emitMs }Zeitaufschlüsselung (ms)
tocTocEntry[]Extrahiertes Inhaltsverzeichnis (leer [], falls TOC deaktiviert)

Verwendung

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 }

Beispiele

Einfaches Markdown zu 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-Eingabe

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-Ausgabe

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-Ausgabe

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-Ausgabe

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