结构化的文档阅读体验,支持多级目录导航、侧边栏、全文搜索和双语切换,为用户提供专业的文档浏览体验。
文档系统
DocsBlog 的文档系统基于 fumadocs 引擎构建,提供专业级的文档阅读和管理体验,适合产品文档、技术手册、知识库等多种场景。
核心特性
结构化导航
通过 meta.json 配置文件定义文档结构,支持多级嵌套和自定义排序,让文档目录层次清晰、一目了然。
侧边栏导航
- 自动生成 -- 根据文档目录结构自动生成侧边栏
- 层级折叠 -- 支持多级目录展开/折叠
- 当前高亮 -- 自动高亮当前阅读的文档位置
- 平滑滚动 -- 点击目录项平滑滚动至对应章节
MDX 增强
文档同样支持 MDX 格式,除了标准 Markdown 语法外,还可以使用:
- 提示框组件 -- Info、Warning、Error 等多种提示样式
- 代码块 -- 支持语法高亮、行号、文件名标注
- 选项卡 -- 在同一区域展示多种方案(如不同语言的代码示例)
- 自定义组件 -- 按需引入 React 组件,实现交互式文档
双语支持
文档系统完整支持中英文双语:
- 每个文档页面可配置对应的翻译版本
- 语言切换时自动跳转到对应语言的同一页面
- 未翻译的页面会优雅降级到默认语言
SEO 优化
- 自动生成结构化的 JSON-LD 数据
- 每个文档页面独立的 meta 信息
- 自动收录到 sitemap 中
- 面包屑导航提升搜索引擎理解