LitMDX

A zero-config documentation framework built on React, MDX, and Vite. Drop a folder of .mdx files, run one command, and get a fast, search-enabled documentation site.

Features

• Zero config — one command, one docs folder. litmdx.config.ts is entirely optional.
• MDX — write standard Markdown with React components embedded naturally.
• File-based routing — the folder structure of docs/ maps directly to URL routes.
• Multi-section — organize large sites by nesting docs in subdirectories (guide/, reference/, etc.).
• Full-text search — powered by Pagefind. No server, no external API.
• Built-in components — callouts, tabs, steps, cards, badges, and code groups available everywhere.
• Auto sidebar — generated from file structure and frontmatter sidebar_position.
• Table of contents — generated from headings on each page.
• Dark & light theme — OS preference detected automatically, toggle available.
• SEO-ready — configurable <title>, description, Open Graph, Twitter Card, favicon.
• Responsive — mobile-first layout with collapsible sidebar drawer.
• Vite-powered — instant dev server, lightning HMR, optimized builds.

Quick start

npx create-litmdx

npm run dev