Overview

Boltdocs turns a folder of Markdown files into a fully rendered, search-indexed, and SEO-optimized documentation site. These guides walk you through every layer of the framework — from getting your first page live in two minutes to building fully custom layouts and injecting your own React components into MDX.

Where to Start

Project Structure

A freshly scaffolded Boltdocs project looks like this:

my-docs/
├── docs/                  # All your content lives here
│   ├── (guides)/
│   │   └── index.mdx
│   └── index.md           # Root page → /docs
├── public/                # Static assets (images, fonts, favicons)
│   ├── dark.svg
│   └── light.svg
├── src/
│   └── components/        # Your custom React components
├── boltdocs.config.ts     # The brain of your docs site
├── index.html             # Vite HTML entry point
├── index.css              # Global styles
└── package.json

Key Directories

docs/ — Everything here becomes a page. Boltdocs recursively scans for .md and .mdx files and turns them into routes. The folder structure maps directly to the URL structure.

boltdocs.config.ts — The single source of truth. Controls theme, navigation, plugins, SEO, i18n, and more. Boltdocs generates the full Vite configuration internally — no separate vite.config.ts needed.

public/ — Static assets served at your site root. Reference them in Markdown with a root-relative path like /my-image.png.

src/components/ — Your custom React components, available for import in .mdx files or registration as global MDX components via plugins.

All Guides