{
  "url": "https://unifast.dev/de/docs/packages/core/overview/",
  "locale": "de",
  "title": "@unifast/core",
  "description": "TypeScript-Typdefinitionen, HAST-Dienstprogramme und Fehlerklassen, die von den unifast-Runtime-Paketen gemeinsam genutzt werden",
  "section": "packages",
  "body": "## Überblick\n\n`@unifast/core` stellt gemeinsam genutzte TypeScript-Typdefinitionen für Kompilierungsoptionen, Ergebnisse, HAST-Knoten (HTML Abstract Syntax Tree), die Plugin-Schnittstelle und Fehlerklassen bereit. Es ist eine Abhängigkeit von Runtime-Paketen wie `@unifast/node` – Sie müssen es in der Regel **nicht** direkt installieren.\n\nVerwenden Sie für den Compiler und die integrierten Plugins [`@unifast/node`](/docs/packages/node/overview).\n\n## Installation\n\n## Typdefinitionen\n\n### CompileOptions\n\nKonfiguration für die Funktion `compile()`.\n\n| Eigenschaft | Typ | Standard | Beschreibung |\n|----------|------|---------|-------------|\n| `inputKind` | `\"md\" \\| \"mdx\"` | `\"md\"` | Eingabeformat |\n| `outputKind` | `\"html\" \\| \"hast\" \\| \"mdast\" \\| \"mdxJs\"` | `\"html\"` | Ausgabeformat |\n| `gfm` | `object` | - | Einstellungen für GitHub Flavored Markdown |\n| `gfm.tables` | `boolean` | - | GFM-Tabellen aktivieren |\n| `gfm.taskList` | `boolean` | - | Aufgabenlisten-Checkboxen aktivieren |\n| `gfm.strikethrough` | `boolean` | - | `~~Durchstreichung~~` aktivieren |\n| `gfm.footnotes` | `boolean` | - | Fußnoten aktivieren |\n| `gfm.autolink` | `boolean` | - | Automatische URL-Verlinkung aktivieren |\n| `frontmatter` | `object` | - | Einstellungen für das Frontmatter-Parsing |\n| `frontmatter.yaml` | `boolean` | - | YAML-Frontmatter parsen |\n| `frontmatter.toml` | `boolean` | - | TOML-Frontmatter parsen |\n| `frontmatter.json` | `boolean` | - | JSON-Frontmatter parsen |\n| `rawHtml` | `\"disallow\" \\| \"allowDangerous\" \\| \"parseAndSanitize\"` | - | Umgang mit Roh-HTML in der Quelle |\n| `sanitize` | `object` | - | Einstellungen für die HTML-Sanitization |\n| `sanitize.enabled` | `boolean` | - | Sanitization aktivieren |\n| `sanitize.schema` | `SanitizeSchema` | - | Benutzerdefinierte Sanitization-Regeln |\n| `highlight` | `object` | - | Einstellungen für die Syntax-Hervorhebung |\n| `highlight.enabled` | `boolean` | - | Syntax-Hervorhebung aktivieren |\n| `highlight.engine` | `\"none\" \\| \"syntect\" \\| \"treeSitter\"` | - | Hervorhebungs-Engine |\n| `slug` | `object` | - | Einstellungen für die Erzeugung von Überschriften-Slugs |\n| `slug.mode` | `\"github\" \\| \"unicode\"` | - | Algorithmus zur Slug-Erzeugung |\n| `toc` | `object` | - | Einstellungen für das Inhaltsverzeichnis |\n| `toc.enabled` | `boolean` | - | TOC-Extraktion aktivieren |\n| `toc.maxDepth` | `number` | - | Maximale einzubeziehende Überschriftentiefe |\n| `diagnostics` | `object` | - | Einstellungen für die Diagnoseausgabe |\n| `diagnostics.format` | `\"compact\" \\| \"verbose\"` | - | Diagnoseformat |\n| `cache` | `object` | - | Einstellungen für das Caching |\n| `cache.enabled` | `boolean` | - | Ergebnis-Caching aktivieren |\n| `cache.dir` | `string` | - | Pfad zum Cache-Verzeichnis |\n| `plugins` | `UnifastPlugin[]` | `[]` | Array der anzuwendenden Plugins |\n\n### CompileResult\n\nWird von der Funktion `compile()` zurückgegeben.\n\n| Eigenschaft | Typ | Beschreibung |\n|----------|------|-------------|\n| `output` | `string \\| object` | Kompilierte Ausgabe (HTML-String, HAST-JSON oder MDAST-JSON, je nach `outputKind`) |\n| `frontmatter` | `Record<string, unknown>` | Geparste Frontmatter-Metadaten |\n| `diagnostics` | `Diagnostic[]` | Array von Warnungen und Fehlern |\n| `stats` | `{ parseMs, transformMs, emitMs }` | Zeitaufschlüsselung in Millisekunden |\n| `toc` | `TocEntry[]` | Extrahierte Inhaltsverzeichnis-Einträge |\n\n### Diagnostic\n\n| Eigenschaft | Typ | Beschreibung |\n|----------|------|-------------|\n| `level` | `\"error\" \\| \"warn\"` | Schweregrad |\n| `message` | `string` | Menschenlesbare Nachricht |\n| `start` | `number \\| undefined` | Start-Byte-Offset in der Quelle |\n| `end` | `number \\| undefined` | End-Byte-Offset in der Quelle |\n| `line` | `number \\| undefined` | Zeilennummer (1-basiert) |\n| `column` | `number \\| undefined` | Spaltennummer (1-basiert) |\n\n### TocEntry\n\nEine einzelne Überschrift, die für das Inhaltsverzeichnis extrahiert wurde.\n\n| Eigenschaft | Typ | Beschreibung |\n|----------|------|-------------|\n| `depth` | `number` | Überschriftsebene (1-6) |\n| `text` | `string` | Textinhalt der Überschrift |\n| `slug` | `string` | Generierter Slug für die Anker-Verlinkung |\n\n### SanitizeSchema\n\nBenutzerdefinierte Sanitization-Regeln.\n\n| Eigenschaft | Typ | Beschreibung |\n|----------|------|-------------|\n| `allowedTags` | `string[]` | Zugelassene HTML-Tags |\n| `allowedAttributes` | `Record<string, string[]>` | Zugelassene Attribute pro Tag |\n| `allowedProtocols` | `Record<string, string[]>` | Zugelassene URL-Protokolle pro Attribut |\n\n### UnifastPlugin\n\nDie Plugin-Schnittstelle zur Erweiterung von unifast.\n\n| Eigenschaft | Typ | Beschreibung |\n|----------|------|-------------|\n| `name` | `string` | Eindeutiger Plugin-Name |\n| `options?` | `Partial<CompileOptions>` | Optionen, die in die Kompilierungsoptionen eingemischt werden |\n| `hastTransform?` | `(hast: HastRoot) => HastRoot` | Transformiert den HAST-Baum nach der Kompilierung |\n\n### HAST-Knotentypen\n\n| Typ | `type`-Feld | Eigenschaften | Beschreibung |\n|------|-------------|------------|-------------|\n| `HastRoot` | `\"root\"` | `children: HastNode[]` | Wurzelknoten des Baums |\n| `HastElement` | `\"element\"` | `tagName`, `properties`, `children` | Ein HTML-Element |\n| `HastText` | `\"text\"` | `value: string` | Ein Textknoten |\n| `HastRaw` | `\"raw\"` | `value: string` | Durchleitung von Roh-HTML |\n| `HastComment` | `\"comment\"` | `value: string` | Ein HTML-Kommentar |\n| `HastDoctype` | `\"doctype\"` | - | Ein `<!DOCTYPE html>`-Knoten |\n\n`HastNode` ist der Vereinigungstyp: `HastRoot | HastElement | HastText | HastRaw | HastComment | HastDoctype`\n\n## Fehlerklassen\n\n| Klasse | Erweitert | Eigenschaften | Beschreibung |\n|-------|---------|------------|-------------|\n| `UnifastError` | `Error` | `code?: string`, `span?: { start, end }` | Basisfehlerklasse für alle unifast-Fehler |\n| `ParseError` | `UnifastError` | `code: \"PARSE_ERROR\"` | Wird ausgelöst, wenn Markdown-/MDX-Eingaben nicht geparst werden können |\n| `CompileError` | `UnifastError` | `code: \"COMPILE_ERROR\"` | Wird ausgelöst, wenn die Kompilierung nach dem Parsen fehlschlägt |\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## Zusammenfassung der Exporte\n\n| Export | Art | Beschreibung |\n|--------|------|-------------|\n| `CompileOptions` | type | Kompilierungskonfiguration |\n| `CompileResult` | type | Kompilierungsergebnis |\n| `TocEntry` | type | Inhaltsverzeichnis-Eintrag |\n| `SanitizeSchema` | type | Sanitization-Regeln |\n| `UnifastPlugin` | type | Plugin-Schnittstelle |\n| `HastNode` | type | Vereinigung aller HAST-Knotentypen |\n| `HastRoot` | type | HAST-Wurzelknoten |\n| `HastElement` | type | HAST-Elementknoten |\n| `HastText` | type | HAST-Textknoten |\n| `HastRaw` | type | HAST-Roh-HTML-Knoten |\n| `HastComment` | type | HAST-Kommentarknoten |\n| `HastDoctype` | type | HAST-Doctype-Knoten |\n| `hastToHtml` | function | HAST-zu-HTML-Serialisierer |\n| `escapeHtml` | function | Maskiert HTML-Sonderzeichen (`&`, `<`, `>`, `\"`) |\n| `extractLang` | function | Extrahiert Sprachbezeichner aus einem HAST-`<code>`-Element |\n| `extractText` | function | Extrahiert den Textinhalt aus einem HAST-Knoten |\n| `findCodeChild` | function | Findet das `<code>`-Kindelement innerhalb eines `<pre>`-Elements |\n| `visitHast` | function | Visitor-Pattern-Dienstprogramm zum Durchlaufen von HAST-Bäumen |\n| `UnifastError` | class | Basisfehlerklasse |\n| `ParseError` | class | Parse-Fehlerklasse |\n| `CompileError` | class | Kompilier-Fehlerklasse |",
  "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"
    }
  ]
}