工程开发
wiki-llms-txt
自动生成 llms.txt 和 llms-full.txt 文件,为项目文档提供 AI 友好的阅读格式及项目上下文。
简介
wiki-llms-txt 工具专为希望提升项目文档 AI 可读性的开发者与技术作者设计。通过生成符合 llms.txt 规范的文件,此技能提供了一个机器可读的切入点,让 AI 代理能更精准地理解您的项目架构、设计限制与操作细节。这有助于减少 AI 的幻觉,并为项目结构、API 文档与上手指南提供明确的真理来源。
-
自动构建包含项目摘要与导航路径的 llms.txt 根文件。
-
生成全面的 llms-full.txt,将完整 Markdown 文档内联集成,同时保留关键的 YAML 前言、引用、表格与 Mermaid 图表。
-
执行严格的文档规范,包括 H1 项目识别、基于块引用的摘要以及逻辑化的块排序(如:上手指南、架构、深入探讨)。
-
执行自动验证,确保所有链接有效、块引用具备项目特异性,并根据上下文窗口限制进行内容分段。
-
在生成文件前,会自动检查 Git 远程仓库与分支状态,确保路径与 URL 的正确性。
-
适用于引入新的 AI 代理或更新文档套件时,以提升其在 AI 辅助开发环境中的可见性。
-
需具备现有的 Wiki 文件才能发挥最佳效用;若当前没有文档,可与 deep-wiki 生成工作流集成使用。
-
操作方式为解析现有的 Markdown 结构,并移除不必要的 YAML 前言,以提供更简洁的 AI 读取体验。
-
用户在执行前应先处理 Git 仓库上下文,以确保相对路径与项目 URL 格式正确。
-
不会覆盖手动创建的根目录 llms.txt,以防止手动配置内容丢失。
仓库统计
- Star 数
- 2,176
- Fork 数
- 249
- Open Issue 数
- 47
- 主要语言
- TypeScript
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年4月29日 14:04