staticql/dist/src/parser/frontMatter.js

Type-safe query engine for static content including Markdown, YAML, JSON, and more.

import { parseYAML } from "./yaml.js";
/**
 * parseMarkdown: Parses a Markdown string with optional YAML frontmatter.
 *
 * Extracts frontmatter (delimited by `---`) as metadata, and returns both attributes and content body.
 *
 * @param rawContent - The raw Markdown string to parse.
 * @returns An object containing parsed frontmatter fields and the remaining Markdown body as `content`.
 */
export function parseFrontMatter({ rawContent }) {
    const frontmatterMatch = rawContent.match(/^---\s*\n([\s\S]*?)\n---\s*\n?/);
    let attributes = {};
    if (frontmatterMatch) {
        const parsed = parseYAML({ rawContent: frontmatterMatch[1] });
        // If the frontmatter is an array, use the first item as attributes
        attributes = Array.isArray(parsed) ? parsed[0] : parsed;
    }
    return attributes;
}