Next.jsReact文档启动器

documentation-template — Next.js 文档模板

作者 deessejs

基于 Next.js、Fumadocs 与 Tailwind 的文档站点模板，用 MDX 写内容，内置全文搜索、OG 图片生成与 LLM 友好端点。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

3 个预览视图

桌面端首页1 / 3

访问演示网站在新标签页打开

桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 3

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-14查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

使用 MDX 编写文档内容，内容文件位于 content/docs/ 并由 meta.json 组织

内置 /api/search 全文搜索，README 标注使用 Orama

提供 /og/docs/[...slug] 自动生成 Open Graph 图片

提供 /llms.txt、/llms-full.txt 与 /llms.mdx/[...slug] 等 LLM 友好端点

包含 lint、类型检查与构建的 GitHub Actions CI 工作流

可通过 GitHub Use this template 或 fork 方式作为新项目起点

模板详细介绍

这是一个文档站点起步模板，README 说明其技术栈为 Next.js、Fumadocs 和 Tailwind，内容以 MDX 编写。模板自带全文搜索、自动生成的 Open Graph 图片、面向 LLM 的端点以及内容协商，并配置了 lint、类型检查与构建的 CI 工作流。

使用方式上，可以克隆仓库后执行 pnpm install 与 pnpm dev 在本地启动，也可以在 GitHub 上点击 Use this template 生成新仓库或直接 fork。定制点包括：应用名称与 GitHub 链接位于 src/lib/shared.ts，内容放在 content/docs/ 下的 .mdx 文件并从 content/docs/meta.json 引用，布局、主题与导航在 src/lib/layout.shared.tsx，路由在 src/app/。

README 列出的路由有首页、文档站、/api/search 全文搜索（Orama）、/og/docs/[...slug] 生成的 OG 图片、/llms.txt、/llms-full.txt 和 /llms.mdx/[...slug]。脚本包括 dev、build、start、lint 与 types:check。README 未提供部署步骤、性能数据或生产环境验证说明；预览截图仅表明存在桌面与移动端截图，不代表页面功能。

Next.js文档启动器

适合你的项目吗？

适用场景

为开源项目或产品搭建 MDX 文档站点
需要全文搜索与自动 OG 图片的文档站
希望向 LLM 提供 llms.txt 与 Markdown 源内容的文档项目
在 GitHub 上以模板方式快速初始化文档仓库

适合人群

使用 Next.js 与 Fumadocs 技术栈的开发者
以 MDX 维护文档内容的团队
需要文档站自带搜索与 LLM 端点的项目
希望复用现成 CI 配置（lint、类型检查、构建）的仓库

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

1
克隆仓库后执行 pnpm install，再用 pnpm dev 启动开发服务器，默认访问 http://localhost:3000
2
可在 GitHub 点击 Use this template 生成新仓库，或直接 fork 本仓库
3
应用名称与 GitHub 链接在 src/lib/shared.ts 中修改
4
内容为 content/docs/ 下的 .mdx 文件，并在 content/docs/meta.json 中引用
5
README 未提供部署步骤，需自行参考 Next.js 相关文档

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

允许免费使用、修改、商用和分发该版本代码。
分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

Permission is hereby granted, free of charge
许可证原文

https://github.com/deessejs/documentation-template/blob/main/LICENSE https://github.com/deessejs/documentation-template/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-14。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台: GitHub
资料与维护参考分: 资料较完整 · 85 / 100
技术栈: Next.js · React
网站类型: 文档 · 启动器

这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间: 2026-07-13
截图检查日期: 2026-10-14

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Next.js。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

审核声明: codex-user-requested-batch-review-20261015 · 2026-10-15

查看当时使用的来源资料

SHA-256: 2b7ea4a8bed369bb5b739c0930f1657502824d394d3aae12ac58570b5f6cc959

2026-10-14T22:28:52.364Z

来源文件 / 仓库

# 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).

反馈内容错误