Repo Wiki 会为你的项目自动生成结构化文档,并持续跟踪代码与文档的变更。
当你在开发过程中查询知识点、代码解释、增加功能特性时,Repo Wiki 会深入分析项目结构和代码实现,结合Repo Wiki 与上下文信息,给出更准确、详细的解答和文档支持,并且让智能体具备更深入代码库认知。
本功能目前处于 Beta 阶段,提供免费的体验限额。额度消耗完后暂无法继续使用,需等待功能正式发布。
适用版本 | 企业标准版、企业专属版 |
Wiki生成
仓库中的 Wiki 不是静态的——它会与代码保持同步。
Wiki 会在三种关键情况下更新。了解它们的触发时机与原因,有助于你保持 Wiki 的实时更新。
初次生成 Wiki
当你首次打开项目时,默认不存在 Wiki。你可以一键从零生成。
典型生成耗时:约 120 分钟(以包含 4,000 个文件的仓库为例)。
在左侧 REPO WIKI (BETA) 面板中,从语言下拉框选择目标语言(如 English),然后单击紫色的生成按钮即可开始生成。
检测到代码变更
初次生成后,系统会持续监控代码的变更。
如果你修改了已被 Wiki 记录的内容(例如函数签名、类定义、API 端点),系统会检测到当前代码与现有 Wiki 的不一致。你可以点击更新仅重新生成受影响的部分。
请将代码变更控制在 10,000 行以内,以避免 Wiki 生成错误。
# 核心模块 <cite> **本文档引用的文件** - [src/app.js](file://src/app.js) - [src/index.js](file://src/index.js) - [src/utils.js](file://src/utils.js) - [README.md](file://README.md) </cite> ## 目录 1. [简介](#简介) 2. [项目结构](#项目结构) 3. [核心组件](#核心组件) 4. [架构概览](#架构概览) 5. [详细组件分析](#详细组件分析) 6. [依赖分析](#依赖分析) 7. [性能考虑](#性能考虑) 8. [故障排除指南](#故障排除指南) 9. [结论](#结论) ## 简介 WikiTest 是一个简单的 JavaScript 应用程序,展示了基础的模块化设计和面向对象编程概念。该项目包含三个核心模块:应用模块、工具模块和主入口模块。每个模块都有明确的职责分工,体现了单一职责原则和模块化开发的最佳实践。 该项目的主要目标是演示: - 模块化 JavaScript 开发模式 - 面向对象编程在前端和后端环境中的应用 - 基础的数据管理和操作模式 - 简单的用户界面交互 ## 项目结构 项目采用扁平化的文件组织结构,所有源代码都位于 `src` 目录下: graph TB subgraph "项目根目录" Root[项目根目录] subgraph "src 目录" App[src/app.js<br/>应用模块] Index[src/index.js<br/>主入口模块] Utils[src/utils.js<br/>工具模块] end subgraph "文档" end endGit 目录同步
如果你直接在 Git 目录中编辑 Markdown 文件,系统会检测到 Git 内容与 Wiki 不一致。你可以点击同步将 Git 中的变更同步并更新 Wiki。
请不要编辑 Git 文件
repowiki/…/meta——这可能导致 Wiki 无法加载。该文件由系统自动管理。
限制
每个项目最多 10,000 个文件
如果项目包含超过 10,000 个文件,建议在 灵码设置 → 代码库索引 → 索引排除 中排除非必要路径。
全量生成支持所有仓库;增量更新仅支持 Git 仓库且至少包含一次提交。
Wiki共享
我们支持 Wiki 共享,助力团队内的知识更高效流动。当你在本地生成 Wiki 时,系统会在代码仓库中自动创建一个专用目录:.lingma/repowiki。
该目录内部按语言和模块组织,例如 .lingma/repowiki/zh/content/ 下会按模块生成对应的 .md 文件(如 核心模块.md、用户服务模块.md、主入口模块.md 等)。
你可以将该目录提交并推送到远程分支。团队成员随后可通过git pull拉取生成的 Wiki 内容——无需额外配置。
多语言支持
Wiki 系统支持多语言——你可以在生成 Wiki 时选择首选语言。目前支持 English 和 中文。在生成 Wiki 时,系统会根据你的语言选择,在 Git 目录下为每种选定的语言自动创建独立目录(例如 repowiki/zh/、repowiki/en/)。
使用场景
架构与实现相关查询
智能体凭借预构建的架构知识,几乎无需调用工具,即可快速解答诸如“X 是如何实现的?”或“哪些服务依赖此模块?”之类的问题。智能体驱动的开发任务
在上下文宽度受限时,Repo Wiki 可加速代码定位,支持以下任务:添加新功能
修复漏洞