Litho (deepwiki-rs)

English | 中文

💪🏻 基于 Rust 构建的高性能 AI 驱动智能文档生成器（类似 DeepWiki） 📚 为任何代码库自动生成高质量的 Repo-Wiki

👋 什么是 Litho

Litho 是一个 AI 驱动的文档生成引擎，能够自动分析您的源代码，并以 C4 模型格式生成全面、专业的架构文档。告别那些总是落后于代码变更的手动文档 —— Litho 让您的文档与代码库保持完美同步。

Litho 将原始代码转化为结构优美的文档，包含上下文图（Context Diagrams）、容器图（Container Diagrams）、组件图（Component Diagrams）以及代码级文档 —— 所有这些均从您的源代码自动生成。

无论您是开发人员、架构师还是技术主管，Litho 都能免除维护文档的负担，并确保您的团队始终拥有准确、最新的架构信息。

在几分钟内将您的代码库转化为专业的架构文档。

Litho 之前	Litho 之后
手动文档	AI 生成文档
文档过时、不完整或缺失	从代码库自动生成
手动更新滞后于代码变更	随代码变更实时更新
格式和结构不统一	专业的 C4 模型结构
维护耗时	格式和风格统一
难以导航和理解	易于导航和理解
通常仅是零散的 Markdown 文件	包含图表、上下文和关系的完整文档

🚀 Litho 自动将您杂乱的代码库转换为精美、专业的文档。

😺 为什么选择 Litho

• 自动保持文档与代码库同步：告别过时的文档。
• 节省数百小时：无需手动创建和维护文档。
• 改善新人入职体验：提供全面且最新的文档，加快上手速度。
• 增强 Code Review：提供清晰的架构上下文。
• 满足合规性要求：提供可审计的自动化文档。
• 支持多种编程语言：支持 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 图表
• 支持文件和内容的智能模糊搜索
• 高性能架构设计