wiki-llms-txt

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

llms.txt Generator

llms.txt 生成工具

Generate

llms.txt

and

llms-full.txt

files that provide LLM-friendly access to wiki documentation, following the llms.txt specification.

按照llms.txt规范生成

llms.txt

和

llms-full.txt

文件，为wiki文档提供LLM友好的访问方式。

When This Skill Activates

触发此技能的场景

User asks to generate
```
llms.txt
```
or mentions the llms.txt standard
User wants to make documentation "LLM-friendly" or "LLM-readable"
User asks for a project summary file for language models
User mentions
```
llms-full.txt
```
or context-expanded documentation

用户要求生成
```
llms.txt
```
或提及llms.txt标准
用户希望让文档变得“LLM友好”或“LLM可读”
用户需要一份供大语言模型使用的项目摘要文件
用户提及
```
llms-full.txt
```
或内容扩展型文档

Source Repository Resolution (MUST DO FIRST)

源仓库上下文解析（必须首先完成）

Before generating, resolve the source repository context:

Check for git remote: Run
```
git remote get-url origin
```
Ask the user: "Is this a local-only repository, or do you have a source repository URL?"
- Remote URL → store as
```
REPO_URL
```
- Local → use relative paths only
Determine default branch: Run
```
git rev-parse --abbrev-ref HEAD
```
Do NOT proceed until resolved

生成文件前，需解析源仓库上下文：

检查git远程仓库：执行
```
git remote get-url origin
```
询问用户："这是仅本地的仓库，还是您有源仓库的URL？"
- 远程URL → 存储为
```
REPO_URL
```
- 本地仓库 → 仅使用相对路径
确定默认分支：执行
```
git rev-parse --abbrev-ref HEAD
```
未完成上述步骤前请勿继续

llms.txt Format (Spec-Compliant)

llms.txt格式（符合规范）

The file follows the llms.txt specification:

markdown

undefined

文件遵循llms.txt规范：

markdown

undefined

{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}: {One-sentence description of what the reader will learn}

{页面标题}: {一句话描述读者将学到的内容}

Optional

Optional（可选）

{Page Title}: {Description — these can be skipped for shorter context}

undefined

{页面标题}: {描述——这些内容可在需要更简洁上下文时跳过}

undefined

Key Rules

核心规则

H1 — Project name (exactly one, required)
Blockquote — Dense, specific summary (required). Must be unique to THIS project.
Context paragraphs — Non-obvious constraints, things LLMs would get wrong without being told
H2 sections — Organized by topic, each with a list of
```
[Title](url): Description
```
entries
"Optional" H2 — Special meaning: links here can be skipped for shorter context
Relative links — All paths relative to wiki directory
Dynamic — ALL content derived from actual wiki pages, not templates
Section order — Most important first: Onboarding → Architecture → Getting Started → Deep Dive → Optional

H1标题 — 项目名称（必须且仅一个）
块引用 — 精炼、具体的摘要（必填）。必须是当前项目独有的内容。
上下文段落 — 不易察觉的约束条件、大语言模型若不被告知就会出错的内容
H2章节 — 按主题组织，每个章节包含
```
[标题](链接): 描述
```
格式的列表项
"Optional" H2章节 — 特殊含义：此处的链接可在需要更简洁上下文时跳过
相对链接 — 所有路径均相对于wiki目录
动态生成 — 所有内容均来自实际wiki页面，而非模板
章节顺序 — 按重要性排序：入门指南 → 架构 → 快速开始 → 深度解析 → 可选内容

Description Quality

描述质量

❌ Bad	✅ Good
"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"

❌ 不佳示例	✅ 优秀示例
"架构概述"	"展示Orleans grains如何通过消息传递实现至少一次交付的系统架构"
"快速开始指南"	"前置条件、使用Docker Compose搭建本地开发环境，以及首次API调用的分步教程"
"API参考文档"	"包含认证要求、速率限制和请求/响应 schema的REST端点说明"

llms-full.txt Format

llms-full.txt格式

Same structure as

llms.txt

but with full content inlined:

markdown

undefined

结构与

llms.txt

相同，但会内联完整内容：

markdown

undefined

{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> ```

<doc title="{页面标题}" path="{相对路径}"> {完整的markdown内容——移除前置YAML，保留引用和图表} </doc> ```

Inlining Rules

内联规则

Strip YAML frontmatter (
```
---
```
blocks) from each page
Preserve Mermaid diagrams — keep
```
```mermaid
```
fences intact
Preserve citations — all
```
[file:line](URL)
```
links stay as-is
Preserve tables — all markdown tables stay intact
Preserve

comments — these provide diagram provenance

移除YAML前置内容（
```
---
```
块）
保留Mermaid图表 — 完整保留
```
```mermaid
```
代码块
保留引用 — 所有
```
[file:line](URL)
```
链接保持原样
保留表格 — 所有markdown表格保持原样
保留

注释 — 这些注释提供图表的来源信息

Prerequisites

前置条件

This skill works best when wiki pages already exist (via

/deep-wiki:generate

/deep-wiki:page

). If no wiki exists yet:

Suggest running
```
/deep-wiki:generate
```
first
OR generate a minimal
```
llms.txt
```
from README + source code scan (without wiki page links)

当wiki页面已存在时（通过

/deep-wiki:generate

或

/deep-wiki:page

生成），此技能效果最佳。若wiki尚未存在：

建议先运行
```
/deep-wiki:generate
```
或通过扫描README和源代码生成最小化的
```
llms.txt
```
（不含wiki页面链接）

Output Files

输出文件

Generate three files:

File	Purpose	Discoverability
`./llms.txt`	Root discovery file	Standard path per llms.txt spec. GitHub MCP `get_file_contents` and `search_code` find this first.
`wiki/llms.txt`	Wiki-relative links	For VitePress deployment and wiki-internal navigation.
`wiki/llms-full.txt`	Full inlined content	Comprehensive reference for agents needing all docs in one file.

The root

./llms.txt

links into

wiki/

(e.g.,

[Guide](./wiki/onboarding/contributor-guide.md)

). The

wiki/llms.txt

uses wiki-relative paths (e.g.,

[Guide](./onboarding/contributor-guide.md)

If a root

llms.txt

already exists and was NOT generated by deep-wiki, do NOT overwrite it.

生成三个文件：

文件	用途	可发现性
`./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)

）。

若根目录已存在非deep-wiki生成的

llms.txt

，请勿覆盖。

Validation Checklist

验证清单

Before finalizing:

All linked files in
```
llms.txt
```
actually exist
All
```
<doc>
```
blocks in
```
llms-full.txt
```
have real content (not empty)
Blockquote is specific to this project (not generic boilerplate)
Sections ordered by importance
No duplicate page entries across sections
"Optional" section only contains truly optional content
```
llms.txt
```
is concise (1-5 KB)
```
llms-full.txt
```
contains all wiki pages

最终生成前需检查：

```
llms.txt
```
中所有链接的文件均真实存在
```
llms-full.txt
```
中所有
```
<doc>
```
块均包含真实内容（非空）
块引用内容是当前项目独有的（非通用模板）
章节按重要性排序
各章节间无重复页面条目
"Optional"章节仅包含真正可选的内容
```
llms.txt
```
内容简洁（1-5 KB）
```
llms-full.txt
```
包含所有wiki页面