s
sopaco/deepwiki-rs
Turn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.
claudedeepseekdeepwikillmmistralopenaiopenrouterrustwiki
RustMIT创建于 2025/9/5更新于 今天
README
由 Gemini 翻译整理
Litho (deepwiki-rs)
💪🏻 基于 Rust 构建的高性能 AI 驱动智能文档生成器（类 DeepWiki） 📚 能够为任意代码库自动生成高质量的 Repo-Wiki
👋 什么是 Litho
Litho 是一个由 AI 驱动的文档生成引擎，能够自动分析您的源代码，并以 C4 模型格式生成全面、专业的架构文档。告别那些总是落后于代码变更的手动文档 —— Litho 让您的文档与代码库保持完美同步。
Litho 将原始代码转化为结构精美的文档，包括上下文图、容器图、组件图以及代码级文档 —— 所有这些均从源代码自动生成。
无论您是开发人员、架构师还是技术负责人，Litho 都能消除维护文档的负担，并确保您的团队始终拥有准确、最新的架构信息。
在几分钟内将您的代码库转变为专业的架构文档
| 之前（Litho） | 之后（Litho） |
|---|---|
| 手动文档 | AI 生成文档 |
| 文档过时、不完整或缺失 | 根据代码库自动生成 |
| 手动更新往往滞后于代码变更 | 始终随代码变更保持最新 |
| 格式和结构不统一 | 专业且符合 C4 模型结构 |
| 维护耗时耗力 | 格式和样式保持一致 |
| 难以导航和理解 | 易于导航和理解 |
| 通常仅包含零散的 Markdown 文件 | 包含完整的图表、上下文和关系 |
🚀 Litho 自动将杂乱的代码库转换为精美、专业的文档
😺 为什么选择 Litho
- 自动保持文档与代码库同步 —— 告别过时的文档
- 节省数百小时 的手动文档编写与维护时间
- 改善团队入职流程，提供全面、最新的文档支持
- 增强代码评审，提供清晰的架构上下文
- 满足合规要求，提供可审计的自动化文档
- 支持多种编程语言（Rust, Python, Java, Go, C#, JavaScript 等）
- 生成专业的 C4 模型图，涵盖上下文、容器、组件和代码
- 集成 CI/CD 流水线，在每次提交时自动生成文档
🌟 适用人群：
- 各种规模的开发团队
- 开源项目维护者
- 企业软件开发人员
- 所有讨厌维护过时文档的人！
❤️ 喜欢 Litho 吗？请给它点个 Star 🌟 或 资助我！❤️
感谢各位的支持
🌠 功能与特性
核心能力
- 基于代码库分析的 AI 驱动架构文档生成
- 自动创建 C4 模型图（上下文、容器、组件、代码）
- 智能提取代码注释、结构和关系
- 多语言支持
- 可自定义的文档输出模板系统
高级特性
- 外部知识集成 - 挂载外部文档（PDF, Markdown, SQL 等）作为知识库，以进行深度分析
- 数据库文档化 - 为 SQL 项目自动生成包含 ERD 图的数据库架构文档
- Git 历史分析，用于追踪架构演进
- 代码元素与文档之间的交叉引用
- 交互式文档，支持嵌入图表和示例
- 集成 CI/CD 流水线，实现自动化文档生成
💡 解决的问题
Litho 通过从源代码自动生成最新的架构文档，解决了技术文档过时和不完整这一常见痛点。无需再手动维护那些跟不上代码变更的文档 —— Litho 让您的文档与代码库始终保持同步。
🌐 Litho 生态系统
Litho 是一个旨在提高开发者生产力和文档质量的工具生态系统的一部分。Litho 生态包含一系列与 Litho 无缝协作的工具，为您提供完整的文档工作流：
📘 Litho Book
Litho Book 是一个基于 Rust 和 Axum 构建的高性能 Markdown 阅读器，专门用于为 Litho 生成的文档提供优雅的浏览界面。
核心特性
- 支持实时渲染带有语法高亮的 Markdown
- 全面支持用于架构图的 Mermaid 语法
- 支持文件和内容模糊匹配的智能搜索
- 高性能架构设计