<p align="center"<img src=".github/art/cover.jpg" alt="Social Card of this repo"</p
BunPress
Fast, modern documentation engine powered by Bun, inspired by VitePress
BunPress is a lightning-fast static site generator designed specifically for documentation. Built on top of Bun's blazing performance with a developer-friendly API inspired by VitePress.
Features
Core Features
- ⚡ Lightning Fast - 0.18s build time (4,000 files), 11x faster than Eleventy
- 📝 Rich Markdown - VitePress-compatible markdown with containers, alerts, code groups, and syntax highlighting
- 📋 Smart TOC - Automatic table of contents with filtering, positioning (sidebar/inline/floating), and interactive navigation
- 🛠️ Developer Friendly - Native TypeScript support, comprehensive CLI (15+ commands), and extensive customization
SEO & Analytics
- 🔍 Complete SEO - Auto-generated sitemap.xml, robots.txt, Open Graph tags, and JSON-LD structured data
- 📊 Fathom Analytics - Privacy-focused analytics with GDPR/CCPA compliance and DNT support
- 🔎 SEO Validation - Built-in SEO checker with auto-fix mode for common issues
Markdown Extensions (VitePress-Compatible)
- ✅ Custom containers (info, tip, warning, danger, details, raw)
- ✅ GitHub-flavored alerts (note, tip, important, warning, caution)
- ✅ Code features (line highlighting, line numbers, focus, diffs, errors/warnings, groups)
- ✅ Code imports from files with line ranges and regions
- ✅ Tables with alignment and formatting
- ✅ Image enhancements with captions and lazy loading
- ✅ Custom header anchors and inline TOC
- ✅ STX template syntax in markdown — dynamic content with @if, @foreach, {{ }}, <script server
Developer Experience
- 🚀 Fast Dev Server - ~100ms startup, hot reload, and instant feedback
- 📦 Small Bundles - ~45KB per page (HTML + JS + CSS)
- 💚 Low Memory - ~50MB dev server, ~250MB peak for 1000 files
- 🎯 15+ CLI Commands - Build, dev, preview, stats, doctor, SEO check, and more
Quick Start
Get started with BunPress in seconds:
# Install BunPress
bun add @stacksjs/bunpress
# Create a new documentation site
mkdir my-docs
cd my-docs
# Initialize with basic structure
bunx @stacksjs/bunpress init
# Start development server
bun run dev