关于 read-docs
read-docs 是用于从 Fumadocs 文档站点检索可靠内容的 Skill。它优先使用页面索引、Markdown 端点和搜索 API,而不是抓取渲染后的网页。
主要功能
- 01通过 llms.txt 发现页面
- 02获取处理后的 Markdown
- 03使用 API 搜索文档
- 04引用原始文档网址
适用场景
- 01查找特定文档页面
- 02检索功能或概念说明
- 03依据项目最新文档回答问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ fuma-nama/ fumadocs --skill read-docs安装后在 Claude Code 中输入/read-docs确认已加载。
详细介绍
一项专用技能,用于从基于 Fumadocs 构建的文档网站中探索并检索准确、简洁的内容。
基于 Fumadocs 构建的网站通常会提供三种便于大模型使用的功能:
-
通过 llms.txt 发现页面
网站会在根 URL 下提供一个纯文本文件:/llms.txt。
该文件包含所有可爬取路由的完整列表(每行一个),通常还会附带注释或元数据,说明哪些路径是文档页面。 -
文档页面的处理后 Markdown
Fumadocs 模板通常会为每个页面在/llms.mdx/docs/<path>/content.md提供处理后的 Markdown(从 MDX 转换而来的纯 Markdown)。有些网站也会通过中间件,将/docs/.../page.mdx重写到该 URL,或通过协商Accept: text/markdown返回该 URL 的内容。
示例:- 渲染后的页面:https://example.com/docs/installation
- 面向大模型的 Markdown:https://example.com/llms.mdx/docs/installation/content.md
如果网站提供此内容,请优先使用,而不是抓取 HTML。
-
搜索 API
网站提供 JSON 搜索端点:
GET /api/search?query= 该端点会返回结构化结果(通常是包含标题、摘要、URL,有时还包含层级信息的对象数组)。
当用户的查询涉及某个库、工具、框架或项目,且其官方文档托管在 Fumadocs 网站上时:
- 首先确认该网站由 Fumadocs 构建(由用户确认、通过已知项目判断,或成功获取
/llms.txt)。 - 获取
/llms.txt,以取得所有可用页面的完整列表。 - 检索特定文档页面内容时,优先使用 Markdown 端点(通常位于
/llms.mdx/docs/下的.../content.md),或者在文档路径后添加.mdx后缀(如果网站采用这种模式)。 - 当用户需要查找某项内容(关键字、功能、概念)时,使用
/api/search端点并提供精确查询。 - 解析原始 MDX 或 JSON 结果并据此推理,提供准确且最新的回答。
- 引用确切的源 URL(为方便用户阅读,优先引用原始渲染页面的 URL,但应以原始版本为依据)。
优先使用这些端点,而不是抓取渲染后的 HTML,以减少噪声并提高准确性。
评论
支持 Markdown