Production-ready documentation starter built with Next.js 16, Fumadocs, and Tailwind v4.
A complete documentation site out of the box: write MDX, get full-text search, auto-generated OG images, LLM-friendly endpoints, content negotiation, and CI.
git clone https://github.com/deessejs/documentation-template.git my-docs
cd my-docs
pnpm install
pnpm devOpen http://localhost:3000.
Click Use this template on GitHub to scaffold a new repository, or fork this one directly.
- App name and GitHub link —
src/lib/shared.ts - Content — add
.mdxfiles incontent/docs/and reference them fromcontent/docs/meta.json - Layout, theme, navigation —
src/lib/layout.shared.tsx - Routes —
src/app/
See the local docs at /docs for a working example.
content/docs/ MDX content
src/app/ Next.js routes (home, docs, api, og, llms.*)
src/lib/ shared config, source loader
src/components/ MDX component overrides
.github/workflows/ CI (lint, types, build)
| Script | Purpose |
|---|---|
pnpm dev |
Start dev server |
pnpm build |
Production build |
pnpm start |
Serve production build |
pnpm lint |
Run ESLint |
pnpm types:check |
Regenerate .source/ and run tsc --noEmit |
| Route | Description |
|---|---|
/ |
Landing page |
/docs |
Documentation site |
/api/search |
Full-text search (Orama) |
/og/docs/[...slug] |
Generated Open Graph images |
/llms.txt |
LLM-friendly sitemap index |
/llms-full.txt |
Concatenated LLM-readable content |
/llms.mdx/[...slug] |
Markdown source for individual pages |
Contributions are welcome — see CONTRIBUTING.md. Open issues using the bug, feature, or documentation templates.
Report private vulnerabilities per SECURITY.md — do not open public issues.
MIT.