行为
Feature #221
打开[AI] 文档页开发
状态:
Resolved
优先级:
Normal
指派给:
-
开始日期:
2026-02-27
计划完成日期:
% 完成:
0%
预期时间:
描述
开发技术文档页面,支持 Markdown 内容渲染,提供良好的文档阅读体验。
页面结构:
- 左侧边栏:文档目录树,支持多级嵌套展开/折叠,当前阅读文档高亮,移动端改为顶部下拉菜单或抽屉式侧边栏
- 中间主内容区:渲染 Markdown 文档内容,支持标题、段落、代码块(带语法高亮)、表格、图片、链接、列表等
- 右侧目录(桌面端):当前文档的 TOC(Table of Contents),滚动时自动高亮当前章节
UI设计要求:
- 文档页采用三栏布局(侧边栏240px + 主内容区自适应 + TOC 200px),移动端隐藏两侧栏
- 代码块使用等宽字体,深色背景(bg-gray-900),支持一键复制按钮
- 代码语法高亮使用 Prism.js 或 highlight.js,支持常见语言(JavaScript, TypeScript, Go, SQL, YAML, Bash)
- Markdown 渲染后的排版遵循良好的阅读体验:行高1.75,段落间距适当,标题层级清晰
- 搜索框(可选):支持文档内关键字搜索
技术要求:
- 使用 react-markdown + remark-gfm 渲染 Markdown
- 使用 rehype-highlight 或 react-syntax-highlighter 实现代码高亮
- 文档目录结构和内容从后端 API 获取(GET /api/v1/docs/tree, GET /api/v1/docs/:slug)
- 后端从数据库或文件系统读取 Markdown 文件
- 实现 URL 路由与文档 slug 映射(/docs/:slug)
- 页面 SEO meta tags 配置
行为