用途
wiki-llms-txt 用于生成 llms.txt 和 llms-full.txt 文件,为 wiki 文档提供符合 llms.txt 规范的、对大语言模型友好的访问方式。
触发场景
该技能在以下情况激活:
- 用户要求生成 llms.txt,或提到 llms.txt 标准
- 用户希望让文档变得“LLM 友好”或“LLM 可读”
- 用户要求为语言模型生成项目摘要文件
- 用户提到 llms-full.txt 或上下文扩展文档
使用方式
第一步:解析源仓库上下文(必须先做)
生成之前,需要先解析源仓库上下文:
- 检查 git remote:运行
git remote get-url origin - 询问用户:“这是仅本地仓库,还是你有源仓库 URL?”
- 远程 URL → 存储为 REPO_URL
- 本地 → 仅使用相对路径
- 确定默认分支:运行
git rev-parse --abbrev-ref HEAD
在解析完成之前不要继续。
llms.txt 格式(符合规范)
文件遵循 llms.txt 规范:
# {Project Name}
> {Dense one-paragraph summary — what it does, who it's for, key technologies}
{Important context paragraphs — constraints, architectural philosophy, non-obvious things}
## {Section Name}
- [{Page Title}]({relative-path-to-md}): {One-sentence description of what the reader will learn}
## Optional
- [{Page Title}]({relative-path-to-md}): {Description — these can be skipped for shorter context}
关键规则:
- H1 — 项目名称(恰好一个,必需)
- Blockquote — 密集、具体的摘要(必需),必须针对本项目唯一
- 上下文段落 — 非显而易见的约束、如果不告知 LLM 就会弄错的内容
- H2 分区 — 按主题组织,每个分区包含一组 标题: 描述 条目
- “Optional” H2 — 特殊含义:此处的链接在需要更短上下文时可跳过
- 相对链接 — 所有路径相对于 wiki 目录
- 动态 — 所有内容均来自实际 wiki 页面,而非模板
- 分区顺序 — 最重要的在前:Onboarding → Architecture → Getting Started → Deep Dive → Optional
描述质量示例:
- 差:“Architecture overview”
- 好:“System architecture showing how Orleans grains communicate via message passing with at-least-once delivery”
- 差:“Getting started guide”
- 好:“Prerequisites, local dev setup with Docker Compose, and first API call walkthrough”
- 差:“The API reference”
- 好:“REST endpoints with auth requirements, rate limits, and request/response schemas”
llms-full.txt 格式
结构与 llms.txt 相同,但内联完整内容:
# {Project Name}
> {Same summary}
{Same context}
## {Section Name}
<doc title="{Page Title}" path="{relative-path}">
{Full markdown content — frontmatter stripped, citations and diagrams preserved}
</doc>
内联规则:
- 从每个页面剥离 YAML frontmatter(--- 块)
- 保留 Mermaid 图 — 保持 ```mermaid 围栏完整
- 保留引用 — 所有 file:line 链接保持原样
- 保留表格 — 所有 markdown 表格保持完整
- 保留 <!-- Sources: --> 注释 — 这些提供图表来源信息
前置条件
当 wiki 页面已经存在时(通过 /deep-wiki:generate 或 /deep-wiki:page),此技能效果最佳。如果尚无 wiki:
- 建议先运行 /deep-wiki:generate
- 或者从 README + 源代码扫描生成一个最小 llms.txt(不含 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)。
如果根目录已存在 llms.txt 且不是由 deep-wiki 生成的,不要覆盖它。
验证清单
最终确定之前:
- llms.txt 中所有链接的文件确实存在
- llms-full.txt 中所有 <doc> 块都有真实内容(非空)
- Blockquote 针对本项目具体(不是通用套话)
- 分区按重要性排序
- 各分区之间没有重复的页面条目
- “Optional” 分区只包含真正可选的内容
- llms.txt 简洁(1-5 KB)
- llms-full.txt 包含所有 wiki 页面
限制
该技能依赖已存在的 wiki 页面以获得最佳效果;若没有 wiki,只能生成不含 wiki 页面链接的最小 llms.txt。根目录已存在且非 deep-wiki 生成的 llms.txt 不会被覆盖。