Building documentation with Preact and Markdown
Structure guides, reference pages, and examples with frontmatter-driven navigation.
Building documentation with Preact and Markdown#
Great docs start with predictable information architecture. PreactPress maps files to routes and lets you configure sidebars in .preactpress/config.ts.
Frontmatter essentials#
| Field | Purpose |
|---|---|
title |
Page title and search index entry |
description |
SEO summary and social cards |
tags |
Tag index pages and related content |
layout |
home, page, or doc chrome |
Callouts and code#
Use fenced code blocks with language tags. PreactPress highlights TypeScript, bash, and more via Shiki.
TIP
Keep reference pages scannable — short paragraphs, tables, and deep-linkable headings.