SuperAPI AI 工具集

wiki-llms-text

写作与研究

查看项目

更新于 10-17 03:35

技能介绍

用途

该技能按照 llms.txt 规范生成两类文件:llms.txt 和 llms-full.txt,为 wiki 文档提供 LLM 友好的访问入口。当用户提出生成 llms.txt、提到 llms.txt 标准、希望让文档“LLM-friendly”或“LLM-readable”、需要面向语言模型的项目摘要文件,或提到 llms-full.txt 与上下文扩展文档时触发。

主要能力

  • 生成符合规范的 llms.txt:包含唯一 H1 项目名、针对本项目的密集 blockquote 摘要、说明非显而易见约束的上下文段落,以及按主题组织的 H2 分区;每个条目为 页面标题: 一句话描述。
  • 支持特殊“Optional”分区,表示该处链接可在缩短上下文时跳过。
  • 所有链接使用相对 wiki 目录的路径,内容全部来自实际 wiki 页面而非模板。
  • 分区顺序按重要性排列:Onboarding → Architecture → Getting Started → Deep Dive → Optional。
  • 生成 llms-full.txt:结构相同,但在每个分区内用 <doc title="…" path="…"> 块内联页面完整 Markdown 内容。
  • 内联规则:去除 YAML frontmatter;保留 Mermaid 图表围栏、引用链接、Markdown 表格以及 <!-- Sources: --> 注释。

使用方式

生成前必须先解析源仓库上下文:运行 git remote get-url origin 检查远程地址,并向用户确认是本地仓库还是存在源仓库 URL;远程地址存为 REPO_URL,本地则仅使用相对路径;同时通过 git rev-parse --abbrev-ref HEAD 确定默认分支。解析完成前不得继续。

该技能最适合在 wiki 页面已存在时使用(例如通过 /deep-wiki:generate 或 /deep-wiki:page 生成)。若尚无 wiki,可建议先运行 /deep-wiki:generate,或基于 README 与源码扫描生成不含 wiki 页面链接的最小 llms.txt。

输出三个文件:

文件 用途 可发现性
./llms.txt 根发现文件 规范标准路径,GitHub MCP 的 get_file_contents 与 search_code 会优先找到
wiki/llms.txt wiki 相对链接 用于 VitePress 部署与 wiki 内部导航
wiki/llms-full.txt 完整内联内容 供需要单文件获取全部文档的智能体使用

根 ./llms.txt 链接进入 wiki/(如 Guide),wiki/llms.txt 使用 wiki 相对路径(如 Guide)。若根目录已存在非 deep-wiki 生成的 llms.txt,不得覆盖。

适用场景

适合已有 wiki 文档、希望让 AI 编码助手或语言模型更准确理解项目结构与约束的仓库。

限制与校验

生成后可对照校验清单检查:llms.txt 中链接的文件确实存在;llms-full.txt 中每个 <doc> 块有真实非空内容;blockquote 针对本项目而非通用套话;分区按重要性排序;跨分区无重复页面;Optional 区仅含真正可选内容;llms.txt 保持简洁(1–5 KB);llms-full.txt 包含全部 wiki 页面。