工程開發
wiki-llms-txt avatar

wiki-llms-txt

自動產生 llms.txt 與 llms-full.txt 檔案,為專案文件提供人工智慧友善的閱讀格式與專案上下文。

簡介

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日 下午02:04
在 GitHub 查看