Headings — Plandalf docs

Use Markdown headings for normal authored pages. Use Heading when imported Mintlify-style MDX already uses component headings, or when a generated page needs to pass the heading level, anchor, and visible title as props.

Default rule

Prefer ## Section title when writing new docs by hand. Keep <Heading /> for ported MDX, generated docs, or pages that need explicit heading props.

Basic heading

Structure your content

The component renders the same document heading semantics as Markdown. The id prop preserves deep links from imported Mintlify pages.

<Heading level="2" id="structure-your-content" title="Structure your content" />

Slot content

Slot heading content

Use slot content when the source MDX passes children instead of a title prop.

<Heading level="3" id="slot-heading">
  Slot heading content
</Heading>

Imported component index

Mintlify’s component index uses explicit headings between component cards. Plandalf supports that pattern directly, while still styling the result like normal docs prose.

Document your API

Fields

Display request parameters, headers, body fields, and props.

Examples

Show request and response examples beside API content.

<Heading level="2" id="document-your-api" title="Document your API" />

<CardGroup cols={2} gap="sm">
  <Card title="Fields" icon="text-cursor-input" href="/docs/components/fields">
    Display request parameters, headers, body fields, and props.
  </Card>
  <Card title="Examples" icon="file-code" href="/docs/components/examples">
    Show request and response examples beside API content.
  </Card>
</CardGroup>

Properties

level1 | 2 | 3 | 4 | 5 | 6default: 2

Controls the rendered heading tag.

idstring

Preserves the anchor target for table-of-contents links and imported deep links.

titlestring

Renders the visible heading text when children are not provided.

childrenstring

Slot content for the visible heading text.

Plandalf extensions

class | classNamestring

Adds a class only when a page has a specific layout need.

Steps Use headings inside progressive procedures only when the step itself needs a section-level anchor.

Cards Use headings before card groups, not inside every card.

Reference Review aliases and imported MDX compatibility notes.