Next.jsReact文档

docs-template — Next.js 文档模板

作者 kevinkenfack

基于 Fumadocs、Next.js 16 与 Tailwind CSS 的文档站点模板,使用 MDX 编写内容,内置搜索与深色模式。

看看你的网站会是什么样

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

3 个预览视图
桌面端首页1 / 3
桌面端截图首屏预览

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

全部页面与视图 3

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

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

值得关注的模板亮点

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

01

使用 Fumadocs 构建,Next.js 16 提供运行时,Tailwind CSS 负责样式

02

文档以 MDX 编写,放在 content/docs/ 下,含 documentation 与 api-reference 两个集合

03

内置全文搜索接口与深色模式,README 称其完全响应式

04

站点品牌与全局链接集中在 lib/site-config.ts,布局选项由 lib/layout.shared.tsx 派生

05

app/[[...slug]]/page.tsx 统一解析所有文档 URL,另有 404 路由与全局 CSS

06

使用 pnpm 作为包管理器,仓库包含 patches/ 目录用于依赖补丁

模板详细介绍

这是一个文档站点模板,README 说明其使用 Fumadocs 构建,运行在 Next.js 16 上,样式由 Tailwind CSS 提供。文档内容以 MDX 文件形式存放在 content/docs/ 目录下,分为 documentation 与 api-reference 两个集合,并通过 meta.json 管理导航元数据。

模板内置全文搜索接口(app/api/search/route.ts)、深色模式与响应式布局,站点品牌与全局链接集中在 lib/site-config.ts,布局选项由 lib/layout.shared.tsx 从该配置派生。路由方面,app/[[...slug]]/page.tsx 负责解析所有文档 URL,另有 404 页面与全局样式文件。

使用方式为克隆仓库后通过 pnpm 安装依赖,运行 pnpm dev 启动开发服务器,pnpm build 进行生产构建。新增文档只需在 content/docs/ 下创建带 title 与 description 前置字段的 MDX 文件。README 未提供部署步骤、环境变量要求、搜索索引的具体实现方式,也未说明除 MIT 许可与欢迎 PR 之外的贡献流程细节。

Next.js文档

适合你的项目吗?

适用场景

  • 为开源项目或产品搭建结构化的使用指南与 API 参考文档站点
  • 需要以 MDX 撰写内容并希望自带搜索、深色模式和响应式布局的文档项目
  • 希望把品牌信息与导航配置集中管理、便于定制的文档模板

适合人群

  • 熟悉 Next.js 与 MDX、愿意通过修改源码定制文档站点的开发者
  • 需要在 content/docs/ 下按集合组织文档内容的团队
  • 使用 pnpm 作为包管理器的项目

上手与定制指南

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

  1. 1

    克隆仓库:git clone https://github.com/kevinkenfack/docs-template.git 并进入目录

  2. 2

    使用 pnpm install 安装依赖

  3. 3

    使用 pnpm dev 启动开发服务器,pnpm build 进行生产构建

  4. 4

    新增文档时在 content/docs/ 下创建 MDX 文件,前置字段包含 title 与 description

  5. 5

    README 未提供部署步骤与环境变量说明,需自行查阅项目内其他文档

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

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

使用时需要遵守

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

额外费用与待核对事项

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

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

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料较完整 · 83 / 100
技术栈
Next.js · React
网站类型
文档
这个分数如何计算

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

这个项目需要核对什么

记录的仓库更新时间
2026-09-05
截图检查日期
2026-10-14

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

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

查看具体选型方法 →

介绍的制作与核对状态

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

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

查看当时使用的来源资料

SHA-256: 9fdb11b1852a1e644ed0c5d0ef7df690a592383dfedb7c24e371fc5fa5a3ef84

2026-10-14T23:00:11.448Z

来源文件 / 仓库
# Docs Template

A stylish documentation template built with Fumadocs, Next.js 16, and Tailwind CSS. It allows anyone to easily create documentation and offers extensive customization options.

## Features

- 📚 Built with Fumadocs
- ⚡ Powered by Next.js 16
- 🎨 Styled with Tailwind CSS
- 📝 MDX-based documentation
- 🌙 Dark mode support
- 🔍 Built-in search
- 📱 Fully responsive
- 🧩 Easy to customize
- 🚀 Ready for production

## Getting Started

```bash
# Clone the repository
git clone https://github.com/kevinkenfack/docs-template.git
cd docs-template

# Install dependencies
pnpm install

# Start development server
pnpm dev

# Build for production
pnpm build
```

## Directory Structure

```text
docs-template/
├── app/                        # Next.js routes, layout, global CSS, and API handlers
│   ├── [[...slug]]/page.tsx    # Resolves every documentation URL
│   ├── api/search/route.ts     # Full-text search endpoint
│   ├── layout.tsx              # Root HTML, providers, and default metadata
│   ├── not-found.tsx           # 404 route
│   └── globals.css             # Tailwind imports and theme tokens
├── components/                 # Reusable React components used by routes and MDX
│   └── ui/                     # Application-owned UI primitives (e.g. Button)
├── content/docs/                # Documentation collections
│   ├── documentation/          # Guides, features, customization docs
│   ├── api-reference/          # API reference docs
│   └── meta.json               # Navigation metadata
├── lib/                         # Site configuration, content loader, and helpers
│   ├── site-config.ts          # Branding and global-link source of truth
│   ├── docs-collections.ts     # Top-level collections and redirects
│   ├── source.ts               # Generated Fumadocs source
│   └── layout.shared.tsx       # Layout options derived from site configuration
├── public/                       # Static files served from `/`
├── patches/                      # pnpm dependency patches
├── source.config.ts              # Defines the `content/docs` collection
├── mdx-components.tsx             # Registers components available in all MDX
├── next.config.ts                 # Next.js configuration wrapped with createMDX()
├── components.json                 # shadcn component aliases and styling choices
├── tsconfig.json                   # Strict TypeScript and `@/*` aliases
└── package.json                    # Commands and dependencies
```

> More details are available in [Project Structure](./content/docs/documentation/project-structure.mdx).

## Adding a Document

You can add a new document by creating an MDX file in `content/docs/`.

```mdx
---
title:
description:
---

Your content goes here.
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

Licensed under the [MIT license](https://github.com/kevinkenfack/docs-template/blob/main/LICENSE).
反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。