Skip to content
CtrlK

ArdoDocContent

On this page

The article, outline, and page actions of a documentation page, without the surrounding layout. Use it inside ArdoLayout in a custom root.

import { ArdoDocContent } from "ardo/ui"

<ArdoDocContent>{children}</ArdoDocContent>

Props

NameTypeRequiredDescription
childrenReactNodeYes
editLink{ pattern: string; text?: string }NoEdit link configuration (overrides ArdoSiteConfig)
lastUpdated{ enabled?: boolean; text?: string; formatOptions?: Intl.DateTimeFormatOptions }NoLast updated configuration (overrides ArdoSiteConfig)
outlineReactNodeNoOptional in-page navigation, displayed after the article heading.
headerReactNodeNoReplace the article heading; false omits it. Undefined keeps the default.
footerReactNodeNoReplace edit/updated metadata and previous/next links; false omits them.
tocLabelstringNoTOC label (forwarded to TOC).
tocSource"metadata" | "dom"NoOutline source. DOM mode includes component-rendered headings after hydration.
railReactNodeNoReplace the right-hand page rail; false omits it. Undefined keeps the default.

Props type: ArdoDocContentProps

Example

<ArdoLayout header={<ArdoHeader />} sidebar={<ArdoSidebar />}>
  <ArdoDocContent>
    <ArdoOutlet />
  </ArdoDocContent>
</ArdoLayout>