Agent Skills
返回列表
💻

Fumadocs React 文档站点生成器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_3c6cb52e/fumadocs-react-documentation-framework-and-docs-site-generator

技能介绍

解决的问题

团队把产品文档、SDK 手册和内部知识库散落在 README、Notion、代码注释里时，读者很难从首页导航快速找到安装步骤、API 参考和排错说明；维护者也要反复处理排版不一致、代码块样式和目录更新。这个技能面向的是“已有 Fumadocs 技术栈的 React 文档项目”，帮助 agent 把文档当作可维护的工程产物，而不是一次性文案。

工作方式

技能围绕 Fumadocs 的 React 文档框架工作，主要承担三类任务：

  • 脚手架：按 Fumadocs 的页面结构生成文档页面骨架，让目录、正文和路由有统一位置。
  • 内容接入：把现有内容接入 content collections，让 frontmatter、正文和导航能按约定被文档站点消费。
  • 组件扩展：为产品文档、SDK 文档或内部知识库补充交互式 UI 组件，例如说明块、切换面板或代码演示区域等可读性组件。

一个典型的 agent 工作流是：先确认站点目标和信息架构，再生成缺失的 docs 页面，然后绑定内容集合并检查导航是否完整，最后为复杂概念增加轻量交互组件。它不改变 Fumadocs 的定位：文档内容、搜索、主题和部署仍由项目与 Fumadocs 生态决定。

适用边界与注意点

适合 文档驱动型项目：文档站、SDK 参考、内部 Wiki 或产品说明站。它不适合凭空生成完整业务系统、市场落地页或与 React/Fumadocs 无关的静态站点。

使用时应保留上游文档约定；如果要扩展核心行为，先对照 fuma-nama/fumadocs 的 README 和 Contributing Guide，避免 PR 与上游流程冲突。变更内容集合类型或页面结构后，需要用文档构建和链接检查验证导航是否仍然可用。

使用场景

  • 在已有 Fumadocs 的 React 项目里，需要为新模块生成文档页面骨架和路由结构。
  • 要把散落在仓库里的 SDK 指南接入 content collections，统一 frontmatter 和导航。
  • 产品文档需要补充交互式组件，比如切换面板和代码演示区域，帮助解释复杂参数。
  • 内部知识库页面结构混乱，需要按 Fumadocs 约定重排目录并补齐缺失的文档页面。

适合人员

  • 前端工程师：想在 Fumadocs 技术栈下快速产出结构一致的文档页面和导航。
  • 技术文档工程师：需要把 API 参考和教程整理成可检索、可浏览的 React 文档站。
  • SDK 维护者：希望将代码示例、参数说明和排错指南接入统一的内容集合，减少手工排版。
  • 内部知识库管理员：关注目录层次、链接有效性和轻量交互组件，便于不同团队查找资料。