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

• ⚡ Lightning Fast - Powered by Bun runtime for incredible performance
• 📝 Rich Markdown - Enhanced markdown with containers, emojis, math, and syntax highlighting
• 📋 Smart TOC - Automatic table of contents with customization and interactive features
• 🛠️ Developer Friendly - TypeScript support, plugin system, and extensive customization options
• 🔍 Advanced Search - Local search with indexing, keyboard shortcuts, and smart ranking
• 🎨 Theme System - Complete theme customization with colors, fonts, and dark mode
• 📱 Responsive Design - Mobile-first design that works beautifully on all devices
• 🧭 Navigation - Flexible navigation with active states, nested menus, and icons
• 📊 Sidebar - Collapsible sidebar with groups, search, and smooth animations
• 🎯 Multiple Layouts - Home, documentation, and page layouts with custom templates

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

# Build for production
bun run build

Basic Usage

Create your first documentation page:

---
title: Welcome
layout: home
---

# Welcome to My Project

This is my awesome project documentation built with BunPress!

## Quick Links

- [Getting Started](/guide/getting-started)
- [API Reference](/api)
- [Examples](/examples)

Configure your site in bunpress.config.ts:

export default {
  nav: [
    { text: 'Home', link: '/' },
    { text: 'Guide', link: '/guide' },
    { text: 'API', link: '/api' }
  ],
  markdown: {
    themeConfig: {
      colors: {
        primary: '#3b82f6'
      }
    }
  }
}

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

• JetBrains
• The Solana Foundation

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙