# React Docs UI

一个基于 React 的、**配置驱动**的现代化文档网站构建工具。

React Docs UI 旨在让创建美观、功能强大的文档网站变得前所未有的简单。你只需专注于编写 Markdown 文档，其他的一切——从路由、导航到主题切换和命令菜单——都通过简单的 YAML 配置来驱动。

## 核心特性

- **配置驱动**: 无需编码，通过 `site.yaml` 定义你的整个网站。
- **开箱即用**: 极速启动项目，内置所有必需功能。
- **现代设计**: 优雅的响应式布局，支持明暗主题自动切换。
- **命令菜单**: 内置 `Cmd+K` 快捷菜单，快速访问页面。
- **Markdown 支持**: 全面支持 GFM 和 Frontmatter。
- **国际化**: 通过配置文件轻松实现多语言支持。

## 快速开始

只需一个命令，即可拥有你的专属文档网站：

```bash
# 创建项目
npx create-react-docs-ui@latest my-docs

# 进入项目目录
cd my-docs

# 安装依赖并启动
npm install && npm run dev
```

## 链接

- **[指南](/zh-cn/guide/introduction)**: 开始了解 React Docs UI 的所有功能。
- **[GitHub](https://github.com/shenjianZ/react-docs-ui)**: 查看源码、提交问题或贡献代码。