ArdoDocPage
On this page
A documentation page with Ardo's layout around it: header, sidebar, article,
outline, and footer. ArdoRoot renders the same for every page; use this
only in a custom root.
import { ArdoDocPage } from "ardo/ui"
<ArdoDocPage>{children}</ArdoDocPage>
Props
| Name | Type | Required | Description |
|---|---|---|---|
children | ReactNode | Yes | |
editLink | { pattern: string; text?: string } | No | Edit link configuration (overrides ArdoSiteConfig) |
lastUpdated | { enabled?: boolean; text?: string; formatOptions?: Intl.DateTimeFormatOptions } | No | Last updated configuration (overrides ArdoSiteConfig) |
outline | ReactNode | No | Optional in-page navigation, displayed after the article heading. |
header | ReactNode | No | Replace the article heading; false omits it. Undefined keeps the default. |
footer | ReactNode | No | Replace edit/updated metadata and previous/next links; false omits them. |
tocLabel | string | No | TOC label (forwarded to TOC). |
tocSource | "metadata" | "dom" | No | Outline source. DOM mode includes component-rendered headings after hydration. |
rail | ReactNode | No | Replace the right-hand page rail; false omits it. Undefined keeps the default. |
Props type: ArdoDocPageProps
Example
<ArdoDocPage>
<ArdoOutlet />
</ArdoDocPage>