展示 HN:Davia – 基于代码库的开源、可视化、可编辑的维基
Show HN: Davia – Open source visual, editable wiki from your codebase

原始链接: https://github.com/davialabs/davia

## Davia:交互式代码文档 Davia 是一款开源工具,可以自动为你的本地代码库生成交互式文档。 简单安装(`git clone`,`cd`,`pnpm i`)后,Davia 会分析你的项目(通过其路径指定),并创建包含动态可视化的文档文件。 你可以在类似 Notion 的平台或直接在 IDE 中编辑这些文档。 Davia 优先使用 Anthropic,然后是 OpenAI,最后是 Google 进行 AI 处理 – 需要通过 `.env` 文件配置 API 密钥。 Davia 工作时,文档窗口会实时填充,允许立即查看和编辑。 结果也可以通过启动的可视化应用程序稍后查看。 Davia 积极寻求贡献 – 欢迎提交错误报告、功能请求和代码改进! 它采用 MIT 许可证。

## Davia:开源代码库文档 Davia 是一款新的开源工具,旨在简化大型代码库的文档记录和理解过程。由 Ruben、Afnan 和 Theo 创建,Davia 可以从代码仓库自动生成可视化的、可编辑的维基。它创建图表,并允许在工具内部或直接在 IDE 中进行编辑,旨在提供更易于访问和维护的内部文档解决方案。 目前处于早期阶段,Davia 利用 LLM(需要用户提供的 API 密钥)创建文档的初稿,供开发者进一步完善。团队认识到数据隐私问题,并计划增加对本地模型的支持。 早期的反馈集中在展示 Davia 在更大、更知名的项目中的应用,而不仅仅是 AI 相关的例子,以及解决文档与代码变更同步的挑战。初步运行分析使用大约 300K-1M tokens 的仓库,耗时约 2 分钟。 该项目在 GitHub 上可用:[https://github.com/davialabs/davia](https://github.com/davialabs/davia),演示地址为:[https://davia.ai/](https://davia.ai/)。
相关文章

原文

Davia Banner

Davia is an open-source tool that generates interactive internal documentation for your local codebase. Point it at a project path and it writes documentation files locally with interactive visualizations that you can edit in a Notion-like platform or locally in your IDE.


git clone https://github.com/davialabs/davia.git
cd davia
pnpm i

By default, Davia looks for a .env file in the root of the project path you provide. Configuration is only optional if there are already API keys in the project path you're generating docs from. To configure API keys in the Davia monorepo instead:

  1. Rename .env.example to .env
  2. Add your AI provider API key (we recommend Anthropic for best results)
  3. Davia will use the first available key in this order: Anthropic → OpenAI → Google

When prompted, enter the absolute path of your project:

Enter absolute path of the project to document: [path of the local codebase you want to document]

Davia spins up a docs window that populates in real time, and you can edit the pages as they appear.

4. View Results (Optional)

If you stopped the process and want to view the results later, you can launch the visualization app manually:

This is the Davia workspace view of your generated docs:

Design Agent Example


Contributions are welcome! We'd love your help to make Davia better:

  • Report bugs or request features — Open an issue to let us know what's not working or what you'd like to see
  • Improve the codebase — Submit pull requests with bug fixes, new features, or optimizations
  • Share feedback — Tell us what you think and help shape Davia's future

davia-docs-demo-github.mp4

This project is licensed under the MIT License - see the LICENSE file for details.

联系我们 contact @ memedata.com