⚡

HexDocs文档获取技能Skill hexdocs-fetcher

该技能专用于通过WebFetch工具高效抓取和转换HexDocs上的Elixir库文档，自动将HTML格式转换为markdown，显著减少令牌使用并提升文档处理效率。适用于软件开发中的文档研究和集成。关键词包括：HexDocs, Elixir, 文档获取, WebFetch, markdown转换, 效率优化, 软件开发。

后端开发 0 次安装 0 次浏览 更新于 3/11/2026

name: hexdocs-fetcher description: 使用WebFetch工具高效获取HexDocs文档。自动将HTML转换为markdown以提高上下文效率。

HexDocs 获取器

使用Claude Code的原生WebFetch工具高效获取来自hexdocs.pm的Elixir库文档。

使用方式

在研究库时，使用WebFetch：

# 获取库概览
WebFetch(
  url: "https://hexdocs.pm/oban",
  prompt: "提取主要文档，包括模块概览、安装说明和关键功能。格式化为干净的markdown。"
)

# 获取特定模块文档
WebFetch(
  url: "https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html",
  prompt: "提取模块文档，包括所有公共函数、其规格和示例。"
)

# 获取入门指南
WebFetch(
  url: "https://hexdocs.pm/ecto/getting-started.html",
  prompt: "提取完整的入门指南内容。"
)

令牌效率

WebFetch自动将HTML转换为markdown并提取相关内容：

来源 原始HTML 使用WebFetch 优势
HexDocs页面 ~80k令牌 ~15k令牌 减少80%
Phoenix文档 ~120k令牌 ~25k令牌 减少79%
README ~20k令牌 ~8k令牌 减少60%

与hex-library-researcher集成

在评估库时，高效获取文档：

# 获取库概览并聚焦提取
WebFetch(
  url: "https://hexdocs.pm/oban",
  prompt: "提取：1) 安装说明 2) 主要功能 3) 基本使用示例"
)

常见HexDocs URLs

# 库概览
https://hexdocs.pm/{library}

# 模块文档
https://hexdocs.pm/{library}/{Module}.html
https://hexdocs.pm/{library}/{Module.Submodule}.html

# 指南
https://hexdocs.pm/{library}/guides.html
https://hexdocs.pm/{library}/{guide-name}.html

# API参考
https://hexdocs.pm/{library}/api-reference.html

提示策略

使用聚焦提示以获得更好的提取效果：

# 用于API文档
prompt: "提取所有公共函数文档，包括@spec和示例"

# 用于指南
prompt: "提取完整指南内容，保留代码示例"

# 用于故障排除
prompt: "提取任何故障排除部分、常见错误和FAQ"

# 用于配置
prompt: "提取配置选项及其默认值"

缓存

WebFetch包含自动15分钟缓存。在会话中多次获取相同URL时，结果自动缓存。

对于更持久的存储，保存到计划目录：

# 获取后，将结果写入文件
Write(
  file_path: ".claude/plans/{slug}/research/docs/oban.md",
  content: "{extracted content}"
)

Tidewave替代方案

如果Tidewave MCP可用，优先使用mcp__tidewave__get_docs以获取精确版本匹配的文档：

mcp__tidewave__get_docs(module: "Oban.Worker")

这获取您mix.lock中精确版本的文档。