Page templates

Every page declares its layout via the template frontmatter field. Three templates ship with Red Glare.

doc (default)

The standard documentation template. Use for reference pages, guides, concept explanations — the vast majority of content.

Layout:

• Left column — auto-generated sidebar navigation.
• Center column — article body with prose styling, breadcrumbs at the top, edit link and prev/next at the bottom.
• Right column — scrollspy table of contents (h2 and h3 headings).

Frontmatter:

---
title: Page title
description: Optional SEO description.
sidebar:
  order: 1
---

splash

Full-width marketing/landing layout. No sidebar, no TOC, no prev/next. Use for:

• Homepages.
• Section index pages that function as landing pages.
• Mini-campaigns ("the new API is live" pages).

Layout:

• Full content width, centered with USWDS's content-area max width.
• No auto-rendered <h1> — you control the visual hierarchy.
• Great with :::link-button directives for CTAs and ::summary-box for feature highlights.

Frontmatter:

---
title: Welcome
template: splash
toc: false
---

This site's home page uses the splash template.

api

Same overall shell as doc, specialized for REST reference. Uses:

• An optional apiVersion frontmatter value for the version pill next to the <h1>.
• The :::endpoint directive, which renders a sticky two-column layout per endpoint (parameters + responses left, request/response examples right).

Frontmatter:

---
title: Branches
description: List, retrieve, and manage repository branches.
template: api
apiVersion: "2026-03-10"
sidebar:
  label: API — Branches
  order: 4
---

See API endpoint example for a full worked example.

Picking a template

Mix and match

You can mix templates freely in the same site. The sidebar is template-agnostic — a splash landing page can sit in the same sidebar group as doc pages, and an api page can appear inside a top-level "Reference" section.

The frontmatter picks the template per-file, not per-directory.