Landing Pages

Sections with children but no explicit page source automatically get a generated landing page. These pages display cards linking to child entries.

When landing pages generate

A landing page is created when a section has:

  • A link field (defines the landing page URL)
  • Child entries (via items or glob from)
  • No from pointing to a single file (that would make it a regular page)
{
  text: 'Guides',
  link: '/guides',
  prefix: '/guides',
  from: 'docs/guides/*.md',
}

Navigating to /guides shows a landing page with cards for each discovered guide.

Overview file promotion

If a section's children include a file named overview.md, index.md, or readme.md, that file is promoted to the section header. Its content becomes the section's landing page instead of the auto-generated cards.

With recursive: true, the indexFile field controls which filename is used (default: "overview"):

{
  text: 'Reference',
  prefix: '/reference',
  from: 'docs/reference/**/*.md',
  recursive: true,
  indexFile: 'overview',
}

Section cards

Sections without workspace metadata display simple cards. Each card shows:

  • Entry name (from text)
  • Description (from child page frontmatter description)
  • Icon colors rotate automatically across cards

Workspace cards

When workspace metadata (from apps, packages, or workspaces) matches a section by docsPrefix, the landing page uses workspace-style cards. These show:

  • Icon with color styling
  • Scope label (e.g. apps/)
  • Name and description
  • Technology tag badges
  • Optional deploy badge

See the Workspaces guide for workspace configuration.

Controlling card content

Card descriptions are resolved in this order (highest priority first):

  1. card.description on the entry
  2. description from the entry's frontmatter
  3. Auto-extracted description from the page content
{
  text: 'API Docs',
  link: '/api',
  from: 'docs/api/overview.md',
  card: {
    description: 'Complete API reference with examples',
    icon: 'pixelarticons:terminal',
  },
}

References