Next.jsReactDocumentationStarter

documentation-template — Next.js Documentation Template

By deessejs

A documentation site template based on Next.js, Fumadocs, and Tailwind, with content written in MDX and built-in full-text search, OG image generation, and LLM-friendly endpoints.

Open Source SiteDownload Source ZIP

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

3 previews
Desktop homepage1 / 3
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 3

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-14View source

What stands out

A quick read of the recorded project description.

01

Documentation content is written in MDX, with content files located in content/docs/ and organized by meta.json

02

Built-in /api/search full-text search, which the README notes uses Orama

03

Provides /og/docs/[...slug] to automatically generate Open Graph images

04

Provides LLM-friendly endpoints such as /llms.txt, /llms-full.txt, and /llms.mdx/[...slug]

05

Includes a GitHub Actions CI workflow for lint, type checking, and build

06

Can be used as a starting point for a new project via GitHub Use this template or by forking

Template Details

This is a documentation site starter template. The README states its tech stack is Next.js, Fumadocs, and Tailwind, with content written in MDX. The template includes full-text search, automatically generated Open Graph images, LLM-oriented endpoints, and content negotiation, and is configured with a CI workflow for lint, type checking, and build.

For usage, you can clone the repository and run pnpm install and pnpm dev to start locally, or click Use this template on GitHub to generate a new repository, or fork it directly. Customization points include: the app name and GitHub link are in src/lib/shared.ts, content is placed in .mdx files under content/docs/ and referenced from content/docs/meta.json, layout, theme, and navigation are in src/lib/layout.shared.tsx, and routing is in src/app/.

The routes listed in the README are the homepage, the documentation site, /api/search full-text search (Orama), OG images generated by /og/docs/[...slug], /llms.txt, /llms-full.txt, and /llms.mdx/[...slug]. Scripts include dev, build, start, lint, and types:check. The README does not provide deployment steps, performance data, or production environment validation notes; the preview screenshots only indicate the existence of desktop and mobile screenshots and do not represent page functionality.

Next.jsDocumentationStarter

Is it right for your project?

Use Cases

  • Building an MDX documentation site for an open-source project or product
  • A documentation site that needs full-text search and automatic OG images
  • A documentation project that wants to provide llms.txt and Markdown source content to LLMs
  • Quickly initializing a documentation repository as a template on GitHub

Suitable For

  • Developers using the Next.js and Fumadocs tech stack
  • Teams maintaining documentation content in MDX
  • Projects that need a documentation site with built-in search and LLM endpoints
  • Repositories that want to reuse an existing CI configuration (lint, type checking, build)

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    After cloning the repository, run pnpm install, then start the development server with pnpm dev, accessible by default at http://localhost:3000

  2. 2

    You can click Use this template on GitHub to generate a new repository, or fork this repository directly

  3. 3

    The app name and GitHub link are modified in src/lib/shared.ts

  4. 4

    Content consists of .mdx files under content/docs/ and is referenced in content/docs/meta.json

  5. 5

    The README does not provide deployment steps; refer to the relevant Next.js documentation as needed

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of that version and does not mean external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of that version's code are permitted.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the complete MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses and cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur separate charges.
View Original Text Basis

Permission is hereby granted, free of charge

Original License Text
https://github.com/deessejs/documentation-template/blob/main/LICENSEhttps://github.com/deessejs/documentation-template/blob/main/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-14. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 85 / 100
Technologies
Next.js · React
Website type
Documentation · Starter
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2026-07-13
Screenshot last checked
2026-10-14

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Next.js as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: codex-user-requested-batch-review-20261015 · 2026-10-15

Inspect the recorded source material

SHA-256: 2b7ea4a8bed369bb5b739c0930f1657502824d394d3aae12ac58570b5f6cc959

2026-10-14T22:28:52.364Z

Source file / repository
# Documentation Template

> Production-ready documentation starter built with Next.js 16, Fumadocs, and Tailwind v4.

[![Build](https://github.com/deessejs/documentation-template/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/deessejs/documentation-template/actions/workflows/build.yaml)
[![Type Check](https://github.com/deessejs/documentation-template/actions/workflows/types.yaml/badge.svg?branch=main&event=push)](https://github.com/deessejs/documentation-template/actions/workflows/types.yaml)
[![Lint](https://github.com/deessejs/documentation-template/actions/workflows/lint.yaml/badge.svg?branch=main&event=push)](https://github.com/deessejs/documentation-template/actions/workflows/lint.yaml)

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.

## Quick start

```bash
git clone https://github.com/deessejs/documentation-template.git my-docs
cd my-docs
pnpm install
pnpm dev
```

Open <http://localhost:3000>.

## Use as a template

Click **Use this template** on GitHub to scaffold a new repository, or [fork](https://github.com/deessejs/documentation-template/fork) this one directly.

## Customizing

- App name and GitHub link — `src/lib/shared.ts`
- Content — add `.mdx` files in `content/docs/` and reference them from `content/docs/meta.json`
- Layout, theme, navigation — `src/lib/layout.shared.tsx`
- Routes — `src/app/`

See the local docs at [`/docs`](http://localhost:3000/docs) for a working example.

## Project structure

```
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)
```

## Scripts

| 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`  |

## Routes

| 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       |

## Contributing

Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md). Open issues using the [bug](.github/ISSUE_TEMPLATE/bug_report.yml), [feature](.github/ISSUE_TEMPLATE/feature_request.yml), or [documentation](.github/ISSUE_TEMPLATE/documentation.yml) templates.

## Security

Report private vulnerabilities per [SECURITY.md](SECURITY.md) — do not open public issues.

## License

[MIT](LICENSE).
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.

Next.js SaaS Starter

Next.js SaaS Starter

The official Next.js SaaS starter template, integrating email/password authentication, Stripe Checkout subscriptions, a dashboard with user/team CRUD, basic Owner/Member RBAC, and activity logging.

Next.js · SaaS

Next.js Commerce

Next.js Commerce

Vercel's officially maintained Next.js App Router ecommerce starter with deep Shopify integration, offering a complete product catalog, cart, and checkout flow. Core logic is modular for swapping backends, and community provider versions exist for BigCommerce, Medusa, and Saleor.

Next.js · E-commerce

Next-js-Boilerplate

Next-js-Boilerplate

A developer-first Next.js 16 starter with Tailwind CSS 4 and TypeScript, supporting both App Router and Page Router.

Next.js · Starter

tailwind-nextjs-starter-blog

tailwind-nextjs-starter-blog

A Next.js and Tailwind CSS blog starter template using Contentlayer for Markdown/MDX, with built-in SEO, code highlighting, and tags. It targets personal technical blogs and migration from Jekyll/Hugo to React, and supports one-click Vercel deployment.

Next.js · Blog

next-forge

next-forge

next-forge is a Turborepo-based Next.js template maintained by Vercel, positioned as a starting point for SaaS products.

Next.js · Starter

SaaS-Boilerplate

SaaS-Boilerplate

SaaS-Boilerplate is an open-source SaaS starter template built with Next.js App Router, React 19, TypeScript, Tailwind CSS, and Shadcn UI.

Next.js · SaaS