Skip to main content

BunPress Docs

Bun-first publishing without the heavyweight setup

Ship docs, blogs, release notes, and product updates that feel clear from day one.

BunPress keeps the structure simple: write Markdown, configure one site file, theme with Nunjucks, and publish static output to GitHub Pages or Vercel. It is built for teams that want polished publishing without turning content into a framework project.

What makes it feel easy

Less setup friction, more publishing momentum.

Fast first publish

Create a site, add a post, and run the dev server with a short Bun-first flow that does not ask you to wire a frontend stack first.

Clear extension model

Themes, plugins, slots, and lifecycle hooks are documented as an official contract, so custom work feels predictable instead of fragile.

Launch-ready defaults

SEO metadata, feeds, sitemaps, redirects, and clean static output are already part of the normal workflow, not release-week add-ons.

Pick your path

Jump into the part that matches your job today.

I want a site running quickly

Start with the shortest path from install to local preview and first publish.

Open Getting Started

I want to understand the product surface

See the authoring, theme, plugin, publishing, and SEO capabilities in one pass.

Open Feature Overview

I want to customize design

Learn the file structure, required layouts, locals, and theme asset model.

Open Theme Overview

I want to extend behavior

Use hooks, helpers, and slot output to shape publishing behavior without forking the core.

Open Plugin Overview

Core release flow

The everyday commands stay small.

Create and write

npx create-bunpress@latest mysite
cd mysite
bun install
bunpress new post "Launch Notes"
bunpress dev

Build and publish

bunpress build
bunpress publish github --dry-run
bunpress publish github
# or
bunpress publish vercel

Read next

Useful follow-ups once the first preview is working.