☰

Pkg.go.dev 文档转 LLM.txt 格式化工具

从 pkg.go.dev 提取 Go 语言包的文档内容（包括 API 定义和代码示例），并将其转换为结构化的 LLM.txt 文本格式，方便在本地使用大型语言模型 (LLM) 进行参考和分析。

作者
hellowor
日安装量
0
总安装量
0
评分
0 0 0
版本
0.1.1
创建于
2025-06-07
更新于
2025-06-07
大小
22.5 KB
许可证
MIT
适用于

此用户脚本旨在帮助 Go 语言开发者和 AI 爱好者，它能够将 pkg.go.dev 上的 Go 语言包文档页面转换为结构化的纯文本格式 (LLM.txt)。这种格式经过优化，非常适合被本地的大型语言模型 (LLM) 读取，从而方便您离线查阅、分析和参考 Go 包的 API 及示例。

脚本会智能提取以下关键信息：

  • 包概览 (Package Overview): 包的主要描述信息。
  • 示例 (Examples): 文档中提供的代码示例，包括其标题和任何相关的输出。
  • 常量与变量 (Constants & Variables): 包级别常量和变量的定义及描述。
  • 函数 (Functions): 包级别函数的签名、描述以及相关示例。
  • 类型 (Types): 结构体、接口等的定义，以及它们的描述和示例。
  • 构造函数与方法 (Constructors & Methods): 对于每种类型，提取其关联的构造函数和方法，包括签名、描述和示例。

输出的 LLM.txt 文件使用类似 Markdown 的格式（例如，## 表示标题，```go 表示代码块）来保持可读性和结构性，这使得 LLM 更容易解析和理解不同文档部分的上下文。

如何使用

  1. 安装脚本管理器:

    • 确保您的浏览器中已安装用户脚本管理器扩展（例如：Tampermonkey, Greasemonkey, Violentmonkey）。
    • 通过访问此脚本的下载地址（例如从 Greasy Fork镜像）并点击“安装”按钮来安装此脚本，或者手动将脚本代码添加到您的用户脚本管理器中。

  2. 访问 Go 包文档页面:

  3. 找到并点击下载按钮:

    • 页面加载完成后，您会在屏幕的右下角看到一个 "Download llm.txt" 按钮。
    • 点击此按钮。

  4. 提取与下载:

    • 脚本会等待一小段时间（约1秒），以确保页面上的动态内容（尤其是代码示例）完全加载。
    • 然后，它将处理页面内容，提取文档并进行格式化。
    • 一个名为 [包名]_llm.txt 的文件（例如：fmt_llm.txt 或 github.com_go-rod_rod_lib_launcher_llm.txt）将自动下载到您浏览器的默认下载位置。

  5. 使用 .txt 文件:

    • 现在您可以将这个 .txt 文件用作您本地 LLM 的参考文档。可以将其导入到 LLM 的知识库中，或在提问时作为上下文提供。

QingJ © 2025

镜像随时可能失效，请加Q群300939539或关注我们的公众号极客氢云获取最新地址