Compass is a free, modern Astro documentation theme for product docs, help centers, and internal knowledge bases. It pairs a calm, readable layout with the tools readers expect from a premium docs site: a ⌘K search palette on every page, a full section sidebar, and an "On this page" outline. You write in MDX, a few config files define the structure, and the whole site builds to static files with no heavyweight docs framework.
Built with Astro 7 and Tailwind CSS 4, Compass is MIT licensed and free for personal and commercial projects.
Features
- ⌘K / Ctrl+K search palette powered by Pagefind, with highlighted excerpts, category labels, and popular articles
- Homepage with a search hero, popular article chips, category cards, recently updated articles, and a support section
- Parent sections, categories, and articles defined in one config file, with a landing page for each level
- Sidebar that lists every article in the section, grouped by category
- "On this page" outline that tracks the heading you're reading, with a compact version on mobile
- Article headers with reading time, last updated date, and a "Copy page" button that copies the page as Markdown
- Heading anchor links, breadcrumbs, previous and next article cards, and related links
- Automatic "Edit this page" links for every article
- MDX components available without imports: callouts, badges, buttons, cards, steps, tabs, code tabs, file trees, tables, accordions, checklists, and quotes
- Light and dark syntax highlighting with language labels and a copy button
- Image lightbox, with local article images optimized by Astro
- Light and dark modes that follow the system setting and remember the reader's choice
- Draft, published, deprecated, and archived article states
- Redirects for moved pages, declared in frontmatter
- RSS feed, sitemap, robots.txt, llms.txt, Open Graph images, and structured data
- Self-hosted Plus Jakarta Sans and JetBrains Mono, local Lucide icons, and design tokens for easy rebranding
- Fully responsive, accessible, keyboard-friendly, and respects reduced motion
- Static output with no client-side framework
- MIT licensed
