lite-matter
lite-matter
lite-matter ist ein ultra-leichtgewichtiger Frontmatter-Extraktor. Er analysiert YAML-Frontmatter-Blöcke aus Markdown-Dokumenten, gibt strukturierte Metadatenobjekte zurück und belässt den Dokumentkörper unverändert.
Warum lite-matter?
Klassische Frontmatter-Parser bringen oft umfangreiche Legacy-Abhängigkeiten mit. lite-matter bietet einen maßgeschneiderten Ersatz für hochperformante statische Website-Generatoren und Build-Tools.
Installation
pnpm
npm
bun
pnpm add lite-matter
npm install lite-matter
bun add lite-matter
Verwendung
Extrahieren Sie Frontmatter-Metadaten und den Dokumentinhalt mit der Funktion matter():
import { matter } from 'lite-matter';
const markdown = `---
title: "Release v0.10.0"
date: 2026-11-12
tags: ["release", "ankuendigung"]
---
# Veröffentlichungsankündigung
Willkommen zur neuesten Version.
`;
const { data, content } = matter(markdown);
console.log(data.title); // "Release v0.10.0"
console.log(data.tags); // ["release", "ankuendigung"]
console.log(content); // "# Veröffentlichungsankündigung\n\nWillkommen zur neuesten Version.\n"
Funktionen
- CRLF-Unterstützung: Verarbeitet Windows- (
\r\n) und POSIX-Zeilenenden (\n) nahtlos. - Verschachtelte Strukturen: Volle Unterstützung für verschachtelte YAML-Objekte, Arrays und mehrzeilige Zeichenfolgen.
- Sichere Fallbacks: Gibt bei fehlendem oder fehlerhaftem Frontmatter sauber leere Metadaten zurück, ohne Ausnahmen auszulösen.
- Inhaltserhaltung: Der Dokumentinhalt bleibt Byte für Byte exakt erhalten.
API-Referenz
matter(input, options?)
Parst einen Text und gibt ein Ergebnisobjekt zurück:
interface MatterResult<T = Record<string, any>> {
data: T;
content: string;
}