Next.jsReact文档启动器

rubix-documents — Next.js 文档模板

作者 rubixvi

基于 Next.js 与 React 的文档站点启动模板，支持 MDX、多级导航、目录生成、代码高亮与模糊搜索，采用 MIT 许可。

打开源站下载源码 ZIP

看看你的网站会是什么样

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

3 个预览视图

桌面端首页1 / 3

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

桌面端截图首屏预览

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

全部页面与视图 3

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

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

值得关注的模板亮点

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

内容以 MDX 编写，可在 Markdown 中直接使用 React 组件

支持 Mermaid.js 图表与流程图、表格和 LaTeX 数学公式

多级导航、自动目录与内容分页

代码块支持语法高亮、标题、行高亮与复制，并提供代码片段切换器

内置明暗模式自动检测，带动态 meta 标签的 SEO 配置

模糊搜索并高亮匹配词项

模板详细介绍

rubix-documents 是一个用 Next.js 和 React 构建的文档站点启动模板，面向产品文档、技术手册、内部指南和业务知识库等场景。内容层支持 MDX（Markdown 中嵌入 React 组件），并提供可复用的自定义组件、Mermaid.js 图表与流程图、表格以及 LaTeX 数学公式。

导航与阅读体验方面，模板提供多级导航、自动生成的目录、内容分页，以及带复制功能的代码片段切换器。开发体验上包含语法高亮与主题支持、可设置标题和行高亮的增强代码块、内置并自动检测的明暗模式，以及带动态 meta 标签的 SEO 配置。搜索采用支持词项高亮的模糊搜索；README 中提到的 AI 知识库工具标注为计划中，尚未实现。

使用流程为克隆仓库后安装依赖、执行 pnpm generate-content-json 生成内容索引，再启动开发服务器；生产环境执行构建与启动命令，也可部署到 Vercel。模板采用 MIT 许可，允许免费使用、修改、商用和分发，但演示图片、字体、图标等第三方素材需单独核对许可，域名、托管等外部服务可能另行收费。

Next.jsReact文档启动器

适合你的项目吗？

适用场景

编写产品文档与用户手册
搭建技术手册或 API 说明站点
整理团队内部指南与规范
构建面向业务的对外知识库

适合人群

需要以 Markdown/MDX 维护文档内容的技术团队
使用 Next.js 与 React 技术栈的前端开发者
希望自带导航、目录、搜索与明暗模式的文档站点项目

上手与定制指南

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

1
克隆仓库后执行 pnpm install 安装依赖
2
运行 pnpm generate-content-json 生成内容索引，再执行 pnpm run dev 本地预览
3
生产环境使用 pnpm run build 与 pnpm run start，或部署到 Vercel
4
MIT 许可仅覆盖本仓库代码，演示图片、字体、图标等第三方素材需单独核对许可
5
README 中提到的 AI 知识库工具为计划功能，当前版本不包含

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

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

使用时需要遵守

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

额外费用与待核对事项

README 将 AI 知识库工具标注为“计划中”，当前版本不包含该功能，不应将其视为已具备的能力。
README 建议部署到 Vercel，使用该托管服务需注册账号并可能产生外部服务费用，与 MIT 代码许可无关。
演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

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

Planned: AI-powered knowledgebase tools
README 原文

Deploy to Vercel for automated builds and hosting.
README 原文

https://github.com/rubixvi/rubix-documents/blob/main/LICENSE https://github.com/rubixvi/rubix-documents/blob/main/README.md

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

项目核对记录与介绍依据

模板资料

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

这个分数如何计算

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

这个项目需要核对什么

记录的仓库更新时间: 2026-10-01
截图检查日期: 2026-10-02

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

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

查看具体选型方法 →

介绍的制作与核对状态

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

已完成服务器许可规则与 AI 来源核对；未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 4ffa65da3590627244cbe29b28a6125059b1282718f6234d77299dae25ad52d0

2026-10-02T09:33:53.180Z

来源文件 / 仓库

# Documents

Documents is a modern documentation starter kit built with **Next.js**, **React**, **Tailwind CSS**, and **TypeScript**. Designed for businesses, product teams, and technical writers, it provides a scalable and efficient foundation for building documentation websites, product manuals, and knowledge bases.

> **Demo**: [https://rubix-documents.vercel.app](https://rubix-documents.vercel.app)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Top Language](https://img.shields.io/github/languages/top/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/rubixvi/rubix-documents)
[![Last Commit](https://img.shields.io/github/last-commit/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents/commits)
[![GitHub issues](https://img.shields.io/github/issues/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents/pulls)

[![GitHub stars](https://img.shields.io/github/stars/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents/network)
[![GitHub repo size](https://img.shields.io/github/repo-size/rubixvi/rubix-documents)](https://github.com/rubixvi/rubix-documents)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents&project-name=my-documents&repository-name=my-documents&demo-title=Documents&demo-description=This%20Document%20Starter%20Kit%20is%20developed%20with%20Next.js%2C%20Tailwind%20CSS%20and%20TypeScript.%20It%20serves%20as%20a%20flexible%20and%20scalable%20foundation%20for%20building%20documentation%20websites%20or%20content-driven%20projects.&demo-url=https%3A%2F%2Frubix-documents.vercel.app%2F&demo-image=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents%2Fblob%2Fmain%2Fpublic%2Fscreens%2Fscreen-1.png)

---

## Overview

Documents enables businesses to deliver clear, structured, and accessible product documentation — with a focus on performance, usability, and maintainability.

Built for technical and content-driven projects, this starter kit supports Markdown (MDX), React components, and a flexible content architecture designed for scale.

---

## Features

### Content Management

- MDX support (Markdown with React components)
- Reusable custom components
- Mermaid.js for diagrams and flowcharts
- Tables and LaTeX math support

### Navigation & Structure

- Multi-level navigation
- Auto-generated table of contents
- Content pagination
- Code snippet switcher with copy functionality

### Development Experience

- Syntax highlighting with theme support
- Enhanced code blocks with titles and line highlighting
- Built-in light/dark mode with auto-detection
- SEO-ready with dynamic meta tags

### Search & Future Enhancements

- Fuzzy search with term highlighting
- Planned: AI-powered knowledgebase tools

---

## Quick Start

### Installation

```bash
git clone https://github.com/rubixvi/rubix-documents.git
cd rubix-documents
pnpm install
pnpm generate-content-json
pnpm run dev
```

Visit [http://localhost:3000](http://localhost:3000) to view your project locally.

**For production:**

```bash
pnpm run build
pnpm run start
```

Deploy to Vercel for automated builds and hosting.

---

## Usage

Documents is designed to support:

- Product documentation
- Technical manuals
- Internal guides
- Business knowledge bases

---

## Screenshots

![Main Screen](./public/screens/screen-1.png)
_Main Screen_

![Document Screen](./public/screens/screen-2.png)
_Document Screen_

![Document Footer](./public/screens/screen-3.png)
_Document Footer_

![Document Search](./public/screens/screen-4.png)
_Document Search_

![Main Dark Screen](./public/screens/screen-5.png)
_Main Dark Mode Screen_

![Document Dark Screen](./public/screens/screen-6.png)
_Document Dark Mode Screen_

---

## Contributing

We welcome contributions to improve this project.

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Open a pull request

---

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

---

## Contact

For support or inquiries:

Vincent Vu — [@rubixvi](https://x.com/rubixvi)

Rubix Studios — [https://rubixstudios.com.au](https://rubixstudios.com.au)

**Project:** [https://github.com/rubixvi/rubix-documents](https://github.com/rubixvi/rubix-documents)

反馈内容错误