Frontmatter Config

Page frontmatter controls per-page metadata and default-theme behavior.

Most keys below are interpreted by the default theme.

Title

Type: string

Used for the page title and document title template interpolation.

---
title: Tab Title
---

# Page Title

The title is formatted from the config:

/* SolidBase options */
{
  titleTemplate: ":title – SolidBase",
}

Layout

Type: "home" | undefined

layout: home enables the default landing page layout.

Effects:

• disables sidebar navigation
• disables footer and table of contents
• disables previous and next navigation
• disables edit link and last updated metadata
• sets copyButton to false

More layout-specific options are available in the Default Theme reference.

Default Theme Page Options

These keys are available on normal documentation pages:

Previous and Next

Type:

type RelativePageConfig =
  | string
  | false
  | {
      text?: string;
      link?: string;
    };

Keys:

• prev
• next

Behavior:

• false disables the generated link
• string overrides the link text
• { text, link } overrides text and target

Actions

The default theme supports page-level action badges with the badges key.

Rendered by Badges.

---
title: Disclosure
badges:
  - icon: npm
    label: 0.2.4
  - icon: gh
    label: source
    url: https://github.com/kobaltedev/solidbase
---

Each action supports:

• icon: a key resolved from themeConfig.badges.icons
• label: the badge text
• url: optional link target. When omitted, the badge renders as static text

Landing Page Options

These keys are used when layout: home is enabled:

hero supports:

• name?: string
• text?: string
• tagline?: string
• image?: { src: string; alt?: string }
• actions?: Array<{ theme?: string; text?: string; link?: string }>

features items support:

• icon?: string
• title?: string
• details?: string

LLMs

Type: false | { exclude?: boolean } | undefined

Controls whether the page is included in generated LLMS documents.

---
title: About
llms:
  exclude: true
---

You can also write llms: false to exclude the page entirely.

Sitemap

Type: false | { exclude?: boolean } | undefined

Controls whether the page is included in generated sitemap output.

---
title: About
sitemap:
  exclude: true
---

You can also write sitemap: false to exclude the page entirely.