deepwiki-open / getting-started.md
Trae Assistant
feat: complete project setup with Docker
dca78e6

快速开始

DeepWiki-Open 是一个开源的 AI 驱动文档生成器。

简介

DeepWiki-Open 能够分析您的代码库结构,理解组件之间的关系,并生成:

  • 包含代码分析和解释的全面文档
  • 展示架构和数据流的自动 Mermaid 图表
  • 基于 RAG 的问答系统,可与您的仓库对话

主要特性

  • 上下文感知 AI: 结合 Google Gemini 和 OpenAI 嵌入模型,在上下文中理解代码。
  • 智能文档生成: 自动生成包含视觉理解的全面文档。
  • 开源: 完全免费,可在本地运行。

准备工作

运行 DeepWiki-Open 需要:

  • Node.js 环境 (如果运行前端)
  • Docker (推荐用于后端部署)
  • AI 提供商的 API Key (Google, OpenAI 等)