read-docs by fuma-nama/fumadocs
npx skills add https://github.com/fuma-nama/fumadocs --skill read-docs一个专门用于从使用 Fumadocs 构建的文档网站探索和检索准确、简洁内容的技能。
Fumadocs 驱动的网站通常提供三种对 LLM 友好的功能:
通过 llms.txt 进行页面发现
网站在根 URL 提供纯文本文件:/llms.txt。
此文件包含可爬取路由的完整列表(每行一个),通常带有注释或元数据,指示哪些路径是文档页面。
文档页面的已处理 Markdown
Fumadocs 模板通常在每个页面的 /llms.mdx/docs/<path>/content.md 处暴露已处理的 Markdown(源自 MDX 的纯 Markdown)。有些网站还会重写 /docs/.../page.mdx 或通过中间件为该 URL 协商 Accept: text/markdown。
例如:
搜索 API 网站暴露一个 JSON 搜索端点: GET /api/search?query= 它返回结构化的结果(通常是包含标题、摘要、URL,有时还有层级结构的对象数组)。
当用户查询涉及某个库、工具、框架或项目,且其官方文档托管在 Fumadocs 网站上时:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
/llms.txt)。/llms.txt 以获得可用页面的完整列表。/llms.mdx/docs/ 下的 .../content.md),或者如果网站使用该模式,则在文档路径上使用 .mdx 后缀。/api/search 端点进行精确查询。优先使用这些端点,而不是抓取渲染后的 HTML,以最大限度地减少干扰并提高准确性。
每周安装量
90
代码仓库
GitHub 星标数
11.3K
首次出现
2026年2月5日
安全审计
安装于
opencode88
gemini-cli87
codex87
github-copilot86
kimi-cli83
amp83
A specialized skill for exploring and retrieving accurate, clean content from documentation websites built with Fumadocs.
Fumadocs-powered sites typically expose three LLM-friendly features:
Page Discovery via llms.txt
The site provides a plain-text file at the root URL: /llms.txt.
This file contains a complete list of crawlable routes (one per line), often with comments or metadata indicating which paths are documentation pages.
Processed Markdown for Docs Pages
Fumadocs templates often expose processed Markdown (plain Markdown derived from MDX) at /llms.mdx/docs/<path>/content.md for each page. Some sites also rewrite /docs/.../page.mdx or negotiate Accept: text/markdown to that URL via middleware.
Example:
Search API
The site exposes a JSON search endpoint:
GET /api/search?query= It returns structured results (usually an array of objects with title, excerpt, URL, and sometimes hierarchy).
When a user query involves a library, tool, framework, or project whose official documentation is hosted on a Fumadocs site:
/llms.txt)./llms.txt to obtain the full list of available pages..../content.md under /llms.mdx/docs/) or a .mdx suffix on the docs path if the site uses that pattern./api/search endpoint with a precise query.Prioritize these endpoints over scraping rendered HTML to minimize noise and maximize accuracy.
Weekly Installs
90
Repository
GitHub Stars
11.3K
First Seen
Feb 5, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykWarn
Installed on
opencode88
gemini-cli87
codex87
github-copilot86
kimi-cli83
amp83
文档查找工具:实时获取库、框架和API最新文档,替代训练数据
1,100 周安装