About Barodoc
The modern documentation framework built on Astro
Barodoc is an open-source documentation framework that turns Markdown into beautiful, production-ready documentation sites. Built on Astro, it combines the simplicity of writing Markdown with the power of a modern web framework.
Our Mission
Make documentation a joy to write, maintain, and read.
We believe every software project deserves great documentation — and creating it shouldn’t require a degree in frontend engineering. Barodoc removes the friction between writing content and publishing a polished site.
How It Works
Barodoc operates in two modes to fit any workflow:
Quick Mode — Write Markdown files, run npx barodoc serve, and you’re done. No setup, no configuration, no dependencies to manage. The CLI handles everything behind the scenes using Astro’s programmatic API.
Full Custom Mode — For teams that need full control, Barodoc provides a standard Astro project structure with reusable components, customizable layouts, and a plugin system.
What’s Included
Every Barodoc site comes with:
- Full-text search powered by Pagefind (no external service)
- Dark mode with automatic OS preference detection
- MDX support for interactive components in Markdown
- Multi-section documentation with independent sidebars
- Sidebar hierarchy — expandable nav groups via
{ "label", "pages" }in config - Blog and changelog content collections
- Responsive design optimized for desktop and mobile
- Syntax highlighting with 100+ languages via Shiki
- i18n with multi-locale content support
Plugin Ecosystem
Extend your site with 8 official plugins:
| Plugin | What It Does |
|---|---|
| Search | Client-side full-text search |
| Sitemap | XML sitemap for SEO |
| RSS | Atom/RSS feeds for subscriptions |
| OG Image | Auto-generated social sharing images |
| PWA | Offline support and installability |
| OpenAPI | API docs from Swagger/OpenAPI specs |
| Analytics | Google Analytics, Plausible, Umami |
| LLMs.txt | AI-readable documentation summary |
Open Source
Barodoc is MIT-licensed and developed in the open. Our code, issues, discussions, and roadmap are all public.
We welcome contributions of all kinds — code, documentation, translations, bug reports, and feature ideas. See our Community page to get involved.