Zum Inhalt springen
⌘K

PostFrontmatter

Als Markdown ansehen
Auf dieser Seite
Diese API-Referenz wird aus den englischen TypeScript-Quellkommentaren erzeugt. Namen, Signaturen und Beispiele entsprechen dem veröffentlichten Paket.

Metadata authored in a post's YAML frontmatter. IDs are assigned once.

import type { PostFrontmatter } from "ardo/ui"

type PostFrontmatter = {
    id: string;
    title: string;
    description?: string;
    publishedAt: string;
    updatedAt?: string;
    authors: string[];
    tags?: string[];
    path?: string;
    draft?: boolean;
    coverImage?: PostImageInput;
    images?: Record<string, Omit<PostImageInput, "alt" | "src"> & {
        alt?: string;
    }>;
    /** Complete static Markdown article for portable outputs when MDX needs a replacement. */
    feedContent?: string;
};

Properties

NameTypeRequiredDescription
idstringYes
titlestringYes
descriptionstringNo
publishedAtstringYes
updatedAtstringNo
authorsstring[]Yes
tagsstring[]No
pathstringNo
draftbooleanNo
coverImagePostImageInputNo
imagesRecord<string, Omit<PostImageInput, "alt" | "src"> & { alt?: string }>No
feedContentstringNoComplete static Markdown article for portable outputs when MDX needs a replacement.