Astro Book

A quiet place for technical writing. Astro Book brings a familiar book layout to Astro: chapters on the left, your words in the middle, and an outline on the right.

Get started → · Explore the reading experience · Browse the source

This documentation site is built with the theme it describes. Every example is public, self-contained and editable in this repository.

Read, write, explore

• Markdown for everyday notes; MDX when a page needs components.
• Code blocks with static syntax colors, titles, highlighted lines and copy buttons.
• Mathematics typeset during the build and Mermaid diagrams loaded when needed.
• Reusable components for hints, article lists, tags and pagination.

A book-shaped interface

Fold chapters in the navigation, follow headings in the table of contents, or use the previous and next links below. On smaller screens, the menu and outline move behind their own controls.

Try the appearance selector in the sidebar. The same document works in light, dark and system modes. Search for mermaid, customization or quadratic to jump directly to a page.

Your site, your choices

The reading shell uses Astro components and static HTML. This demo has no React renderer, commercial UI package or backend. You can choose your own content model and add framework islands in your own project.

Start with the project structure, then adjust the configuration and layout slots. The theme takes inspiration from Hugo Book; this site documents the Astro implementation.