Skip to content
CtrlK

PageFrontmatter

On this page
import type { PageFrontmatter } from "ardo/config"

type PageFrontmatter = {
    title?: string;
    description?: string;
    canonical?: string;
    ogDescription?: string;
    ogImage?: string;
    ogTitle?: string;
    ogType?: string;
    twitterCard?: "summary_large_image" | "summary";
    twitterDescription?: string;
    twitterImage?: string;
    twitterTitle?: string;
    order?: number;
    collapsed?: boolean;
    /** `bare` drops the sidebar and the page rail, as on a landing page. */
    layout?: "bare" | "default";
    sidebar?: "leaf" | boolean;
    outline?: [number, number] | boolean | number;
    editLink?: boolean;
    lastUpdated?: boolean;
    sitemap?: boolean;
    /** Set to false to use description only as metadata, not as visible page lede. */
    lede?: boolean;
    llms?: boolean;
    redirectFrom?: string | string[];
    prev?: {
        text: string;
        link: string;
    } | false | string;
    next?: {
        text: string;
        link: string;
    } | false | string;
    hero?: {
        name?: string;
        text?: string;
        tagline?: string;
        image?: {
            light: string;
            dark: string;
        } | string;
        actions?: Array<{
            text: string;
            link: string;
            theme?: "alt" | "brand";
        }>;
    };
    features?: Array<{
        icon?: string;
        title: string;
        details: string;
        link?: string;
        linkText?: string;
    }>;
} & Record<string, unknown>;

Properties

NameTypeRequiredDescription
titlestringNo
descriptionstringNo
canonicalstringNo
ogDescriptionstringNo
ogImagestringNo
ogTitlestringNo
ogTypestringNo
twitterCard"summary_large_image" | "summary"No
twitterDescriptionstringNo
twitterImagestringNo
twitterTitlestringNo
ordernumberNo
collapsedbooleanNo
layout"bare" | "default"Nobare drops the sidebar and the page rail, as on a landing page.
sidebar"leaf" | booleanNo
outline[number, number] | boolean | numberNo
editLinkbooleanNo
lastUpdatedbooleanNo
sitemapbooleanNo
ledebooleanNoSet to false to use description only as metadata, not as visible page lede.
llmsbooleanNo
redirectFromstring | string[]No
prev{ text: string; link: string } | false | stringNo
next{ text: string; link: string } | false | stringNo
hero{ name?: string; text?: string; tagline?: string; image?: { light: string; dark: string } | string; actions?: Array<{ text: string; link: string; theme?: "alt" | "brand" }> }No
featuresArray<{ icon?: string; title: string; details: string; link?: string; linkText?: string }>No

Index signatures

[key: string]: unknown;