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
| Name | Type | Required | Description |
|---|---|---|---|
title | string | No | |
description | string | No | |
canonical | string | No | |
ogDescription | string | No | |
ogImage | string | No | |
ogTitle | string | No | |
ogType | string | No | |
twitterCard | "summary_large_image" | "summary" | No | |
twitterDescription | string | No | |
twitterImage | string | No | |
twitterTitle | string | No | |
order | number | No | |
collapsed | boolean | No | |
layout | "bare" | "default" | No | bare drops the sidebar and the page rail, as on a landing page. |
sidebar | "leaf" | boolean | No | |
outline | [number, number] | boolean | number | No | |
editLink | boolean | No | |
lastUpdated | boolean | No | |
sitemap | boolean | No | |
lede | boolean | No | Set to false to use description only as metadata, not as visible page lede. |
llms | boolean | No | |
redirectFrom | string | string[] | No | |
prev | { text: string; link: string } | false | string | No | |
next | { text: string; link: string } | false | string | No | |
hero | { name?: string; text?: string; tagline?: string; image?: { light: string; dark: string } | string; actions?: Array<{ text: string; link: string; theme?: "alt" | "brand" }> } | No | |
features | Array<{ icon?: string; title: string; details: string; link?: string; linkText?: string }> | No |
Index signatures
[key: string]: unknown;