mcpField
L
llms-txt

llms-txt

github.com/thatrebeccarae营销与增长187107 次安装24 周前更新
代码仓库

关于 llms-txt

llms-txt 是用于为项目仓库和文档站点创建、维护精选 llms.txt 文件的技能。它会扫描并筛选内容，支持生成、审查和更新文件。

主要功能

  1. 01根据仓库生成 llms.txt
  2. 02检查链接和内容覆盖
  3. 03保留手动编辑内容并更新
  4. 04为 LLM 筛选文档
  5. 05可选生成 llms-full.txt

适用场景

  1. 01为新项目准备 AI 可发现性文件
  2. 02文档变更后检查 llms.txt
  3. 03更新链接与页面描述
  4. 04创建面向 LLM 的文档索引

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/thatrebeccarae/claude-marketing --skill llms-txt

安装后在 Claude Code 中输入/llms-txt确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

EXAMPLES.md
LICENSE
REFERENCE.md

详细介绍

llms.txt 生成器

生成并维护 llms.txt 文件，帮助 AI 答案引擎准确展示你的项目。

安装

git clone https://github.com/thatrebeccarae/claude-marketing.git && cp -r claude-marketing/skills/llms-txt ~/.claude/skills/

适用场景

  • 发布新的开源项目或文档网站
  • 大幅调整文档结构或全面更新内容
  • 提升项目在 AI 搜索中的曝光度（ChatGPT、Perplexity、Google AI Overviews）
  • 让项目符合便于 AI 发现的标准
  • 在仓库发生重大变化后定期更新

什么是 llms.txt

llms.txt 是放在项目根目录中的纯文本 Markdown 文件，为大模型提供项目最重要内容的精选索引。可以把它看作面向 AI 理解的 robots.txt——它不是告诉爬虫可以访问哪些位置，而是告诉它们哪些内容最重要，以及项目的组织方式。

该规范由 Answer.AI 提出，相关文档见 llmstxt.org。越来越多的开发者工具、文档网站和开源项目开始采用这项规范。包含 llms.txt 的项目更容易被 AI 理解、引用和准确推荐。

用法

/llms-txt generate [repo-path]

扫描仓库并生成新的 llms.txt 文件。如果未提供路径，则使用当前工作目录。

/llms-txt audit [repo-path]

检查现有 llms.txt 的完整性、失效链接、过时描述和缺失的高优先级内容，并生成包含具体建议的报告。

/llms-txt update [repo-path]

根据当前仓库状态更新现有 llms.txt。保留手动编写的描述，同时添加新内容并移除对已删除文件的引用。

流程

步骤 1：扫描仓库结构

识别仓库中所有与文档相关的文件：

  • README.md（根目录及重要子目录中的文件）
  • docs/ 目录及其内容
  • API 文档（OpenAPI 规范、API 参考页面）
  • 教程、指南和入门内容
  • CHANGELOG.md、CONTRIBUTING.md、FAQ.md
  • 架构和设计决策文档
  • 配置和部署指南
  • 包含各自 README 的示例目录
步骤 2：排列内容优先级

根据大模型了解项目所需的重要程度，对发现的内容进行排序：

优先级内容类型重要性
P0README、入门指南、API 参考入口——项目是什么以及如何使用
P1教程、指南、架构文档深入了解——项目如何运作以及常见工作流
P2CHANGELOG、CONTRIBUTING、FAQ、配置文档补充背景——历史、社区、问题排查
步骤 3：提取元数据

为每个内容页面提取或编写以下信息：

  • 标题：清晰且有描述性的页面标题
  • URL 或路径：内容的位置（托管文档使用完整 URL，仓库文件使用相对路径）
  • 描述：用一句以行动为导向的话概述页面内容
步骤 4：生成 llms.txt

按照规范格式组装文件：

  1. 标题行：# Project Name
  2. 描述块：用 2-3 句话概述项目的功能、目标用户和主要用途
  3. 分区：按逻辑对内容分组（例如，“入门”、“API”、“指南”、“社区”）
  4. 内容条目：每项都是带有冒号分隔描述的 Markdown 链接

确切的格式规范请参阅 REFERENCE.md。

步骤 5：可选生成 llms-full.txt

对于适合生成扩展版本的项目，可将关键页面的实际内容内嵌其中。对于文档较少、完整文档可放入单个上下文窗口的项目，这种方式很有用。

步骤 6：用户审核

提交生成的 llms.txt 供用户审核。标明整理过程中做出的决定：

  • 未纳入的内容及其原因
  • 根据现有元数据推断的描述与从现有元数据中提取的描述
  • 增加文档有助于提升 AI 可发现性的分区
步骤 7：写入仓库根目录

将 llms.txt（以及可选的 llms-full.txt）保存到仓库根目录。

对于提供托管文档站点的项目，还应注明托管版本的推荐放置位置（站点根目录，例如 https://docs.example.com/llms.txt）。

托管文档和 GitHub Pages

如果项目有文档站点（GitHub Pages、ReadTheDocs、Docusaurus 等）：

  • 生成 llms.txt 时使用指向托管文档的完整 URL，而不是仓库文件路径
  • 将文件放在可通过 https://yourdomain.com/llms.txt 访问的位置
  • 对于 GitHub Pages：将 llms.txt 添加到文档源目录，以便自动部署
  • 考虑将 llms.txt 添加到站点地图，或在 robots.txt 中链接到它

核心原则

  1. 精心筛选，而不是一股脑倾倒。 列出仓库中所有文件的 llms.txt 毫无用处，甚至更糟。选择最重要的 10-30 个页面，让大模型最清晰地了解项目。
  2. 优先列出入口页面。 前几项应回答：这是什么、适合哪些人，以及如何开始？
  3. 让描述以行动为导向。 “如何为 SSO 提供商配置身份验证”胜过“身份验证配置页面”。
  4. 符合读者的认知模式。 按照新手了解项目的方式组织章节，而不是按照仓库的结构组织。
  5. 保持内容最新。 链接失效或描述过时的 llms.txt 会损害信任。文档发生重大变更后，运行 /llms-txt audit。

与其他技能集成

  • aeo-geo-optimizer — llms.txt 可补充更广泛的 AI 搜索优化；同时使用两者，最大限度提升 AI 可发现性
  • technical-seo-audit — 生成 llms.txt 前，确保 AI 爬虫能够访问你的文档
  • github-readme — 优秀的 README 是优质 llms.txt 的基础；先对其进行优化

有关完整的规范格式、优先级排序标准和放置指南，请参阅 REFERENCE.md。

评论

支持 Markdown