wiki-llms-txt

llms.txt 生成器

生成 llms.txt 和 llms-full.txt 文件，为大模型提供易于读取的 Wiki 文档访问方式，并遵循 llms.txt 规范。

此技能的触发条件

• 用户要求生成 llms.txt，或提及 llms.txt 标准
• 用户希望让文档“便于大模型使用”或“大模型可读”
• 用户要求为语言模型生成项目摘要文件
• 用户提及 llms-full.txt 或扩展上下文文档

源代码仓库解析（必须首先执行）

生成前，先解析源代码仓库上下文：

1. 检查 git 远程仓库：运行 git remote get-url origin
2. 询问用户：“这是仅在本地使用的仓库，还是有源代码仓库 URL？”
   • 远程 URL → 保存为 REPO_URL
   • 本地 → 仅使用相对路径
3. 确定默认分支：运行 git rev-parse --abbrev-ref HEAD
4. 解析完成前，不要继续

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}

关键规则

1. H1 — 项目名称（必须且只能有一个）
2. 引用块 — 简洁、具体的摘要（必需）。必须专属于此项目。
3. 上下文段落 — 说明非显而易见的约束，以及大模型若不知晓便容易出错的事项
4. H2 章节 — 按主题组织，每个章节包含 [标题](url)：描述 条目列表
5. “Optional” H2 — 具有特殊含义：可跳过此处的链接，以缩短上下文
6. 相对链接 — 所有路径均相对于 Wiki 目录
7. 动态生成 — 所有内容均从实际 Wiki 页面中提取，而非使用模板
8. 章节顺序 — 按重要性从高到低排列：入门指南 → 架构 → 开始使用 → 深入了解 → Optional

描述质量

❌ 不佳	✅ 良好
“架构概览”	“系统架构展示 Orleans grain 如何通过消息传递进行通信，并提供至少一次投递保障”
“入门指南”	“前置条件、使用 Docker Compose 配置本地开发环境，以及首次 API 调用演练”
“API 参考”	“REST 端点、身份验证要求、速率限制以及请求/响应架构”

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 前置元数据（--- 块）
• 保留 Mermaid 图表 — 完整保留 ```mermaid 代码围栏
• 保留引用 — 所有 [file:line](URL) 链接均保持原样
• 保留表格 — 保持所有 Markdown 表格完整
• 保留 `` 注释 — 这些注释提供图表来源信息

前置条件

当 Wiki 页面已存在时，此技能效果最佳（通过 /deep-wiki:generate 或 /deep-wiki:page 生成）。如果尚无 Wiki：

1. 建议先运行 /deep-wiki:generate
2. 或根据 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	内联完整内容	为需要在单个文件中获取所有文档的 Agent 提供全面参考。

根目录的 ./llms.txt 链接到 wiki/ 中的文件（例如，[指南](./wiki/onboarding/contributor-guide.md)）。wiki/llms.txt 使用相对于 Wiki 的路径（例如，[指南](./onboarding/contributor-guide.md)）。

如果根目录下已存在 llms.txt，且该文件并非由 deep-wiki 生成，则不要覆盖它。

验证清单

完成前请确认：

• llms.txt 中链接的所有文件均真实存在
• llms-full.txt 中的所有 <doc> 块均包含实际内容（不为空）
• 引用块是针对本项目的（而非通用模板内容）
• 各部分按重要性排序
• 各部分之间没有重复的页面条目
• “Optional” 部分只包含真正可选的内容
• llms.txt 简洁（1-5 KB）
• llms-full.txt 包含所有 wiki 页面