Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问许可证需确认审计提醒

read-docs阅读文档

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

3,164

周安装

128

GitHub Stars

11,737

下载量

993
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:read-docs(阅读文档)
来源仓库:https://github.com/fuma-nama/fumadocs
仓库路径:skills/read-docs
安装命令:
npx skills add https://github.com/fuma-nama/fumadocs --skill read-docs
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/fuma-nama/fumadocs --skill read-docs

简介

用于辅助各类文档的阅读与结构梳理,适合在 Codex、Claude、Cursor、Gemini CLI 中快速提炼要点、补齐章节。

  • 支持统一术语、检查链接有效性和优化段落逻辑,提升文档质量。
  • 通过 npx skills add 命令从指定仓库安装,需确认本地环境是否支持 GitHub 技能加载。
  • 使用前建议核对项目路由、构建配置及测试框架版本,避免只生成孤立片段。
  • 涉及对外文案时,应控制语气,避免过度营销或夸大能力。

SKILL.md

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:

  1. 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.
  2. 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:

- Rendered page: https://example.com/docs/installation - Markdown for LLMs: https://example.com/llms.mdx/docs/installation/content.md Prefer this over scraping HTML when the site exposes it.

  1. 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:

  • First, confirm it is Fumadocs-powered (user confirmation, known projects, or successfully fetching /llms.txt).
  • Fetch /llms.txt to obtain the full list of available pages.
  • When retrieving the content of a specific docs page, prefer the markdown endpoint (often .../content.md under /llms.mdx/docs/) or a .mdx suffix on the docs path if the site uses that pattern.
  • When the user needs to find something (keyword, feature, concept), use the /api/search endpoint with a precise query.
  • Parse and reason over the raw MDX or JSON results to provide accurate, up-to-date answers.
  • Cite the exact source URL (prefer the original rendered URL for user readability, but base your understanding on the raw version).

Prioritize these endpoints over scraping rendered HTML to minimize noise and maximize accuracy.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

33.41%
按下载量换算332

Claude

31.06%
按下载量换算308

Cursor

17.33%
按下载量换算172

Gemini CLI

9.22%
按下载量换算92

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

可疑

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills