synthadoc

把文档自动编译成可视化 Wiki,告别黑盒 RAG

Synthadoc 是一个开源的 LLM 知识编译引擎,旨在将原始文档转化为结构化的本地优先 Wiki。它解决了传统 RAG 系统在可解释性和可维护性上的痛点,通过生成人类可读的知识图谱和文档链接,让用户无需额外工具即可自主管理和改进知识库。核心能力包括:基于 agent 的文档解析与知识抽取,支持本地 LLM 部署,输出与 Obsidian 等 Markdown 工具兼容的格式,并强调领域自适应和 CLI 操作。项目处于早期阶段,但设计理念新颖,适合对知识管理有深度需求的个人或企业用户。

开源 free 搜索知识
访问官网 ↗ GitHub ↗ 文档 ↗
GitHub 星标 ★ 1332
维护状态 活跃
是否开源 是
定价模式 free

项目数据

分类搜索知识
开发团队axoviq-ai
所属国家
官网地址
定价模式free
价格说明开源项目,AGPL-3.0许可,可自行部署使用,无付费版本。
访问状态
是否开源是
开源协议AGPL-3.0
主要语言Python
技术栈/模型agent-skills,agentic-ai,cli-tool,domain-adaptation,enterprise,enterprise-solutions,knowledge-graph,local-llm,obsidian-md,obsidian-plugin,personal-knowledge-management,pkm,rag-alternative,synthetic,synthetic-data
GitHub 星标★ 1332
30天Star增速
HF 下载量
上线时间2026-04-11 00:00:00
最近更新2026-09-23 00:00:00
维护状态活跃
中文支持
访问方式
移动端支持
综合评分
收录时间2026-08-10
浏览次数4

使用教程

难度:入门 约 10 分钟 部署方式:本地安装 8 步

环境要求

  • Python 3.11 或更高版本
  • git 与 pip 可用的命令行环境
  • 本地磁盘可写目录(示例使用 ~/wikis)
  • 如需完整测试:需源码检出(pip wheel 不含 tests),并会安装 pytest、respx 等 dev 依赖
  • 仅浏览官方演示 Wiki 时无需 LLM API Key

安装与启动步骤

  1. 1克隆仓库

    从 GitHub 拉取 synthadoc 源码,并进入项目目录,后续命令都在此目录执行。

    git clone https://github.com/axoviq-ai/synthadoc.git
    cd synthadoc
  2. 2安装依赖

    以可编辑模式安装项目,[dev] 额外安装 pytest、respx 等测试依赖,测试必须用源码安装。

    pip install -e ".[dev]"
  3. 3运行测试套件

    跳过性能基准跑完整测试,预期全部通过、0 失败;基准测试为可选项。

    pytest --ignore=tests/performance/ -q
  4. 4浏览可用模板

    列出 9 大类共 30 个领域模板,挑选最接近自己领域的模板再安装。

    synthadoc templates list
  5. 5安装一个 Wiki

    按模板安装(示例为市场研究模板);也可换用 --domain 描述,或无参数安装演示。

    synthadoc install my-market-wiki --target ~/wikis --template research/market-research
  6. 6设为默认 Wiki

    把刚安装的 Wiki 设为默认,之后命令无需再带 -w 参数指定。

    synthadoc use my-market-wiki
  7. 7安装演示 Wiki

    History of Computing 演示含 13 个预建页面与原始素材,无需调用 LLM。

    synthadoc install history-of-computing --target ~/wikis --demo
  8. 8启动服务

    配置好 API Key 环境变量后运行 serve 启动引擎;演示 Wiki 无需任何配置。

    synthadoc serve

如何确认成功

运行 synthadoc status -w my-wiki 查看是否有 pre-flight 警告;无警告即安装配置正常。

常见问题

Q:测试为什么必须在源码目录跑?

A:README 说明 pytest、respx 等测试依赖只在 [dev] 附加项中,且 tests 目录不包含在 pip wheel 里,必须用 git clone 的源码检出运行。

Q:不配置 LLM API Key 能用吗?

A:可以。官方 History of Computing 演示自带预建页面和设置,浏览时无需 API Key;其余场景需设置 API Key 环境变量并运行 synthadoc serve。

Q:没有合适的模板怎么办?

A:可以安装时不带 --template,改用 --domain "你的领域描述",由 LLM 自动生成脚手架。

Q:如何卸载一个 Wiki?

A:执行 synthadoc uninstall my-wiki,需要两步确认,没有 --yes 之类的跳过参数。

注意事项

  • scaffold 操作不会修改 wiki 中的 config.toml 和 dashboard.md,可放心重跑。
  • Wiki 安装默认端口自动分配以避免冲突,无需手动指定端口。
  • 可定期刷新:synthadoc schedule add --op "scaffold" --cron "0 4 * * 0" -w my-wiki 表示每周日 4 点执行。
  • 当前为 Community Edition v1.3.3,项目仍处早期阶段,配置细节请参考 docs 下的 Quick-Start Guide 与 design.md。

核心亮点

  • 输出人类可读的 Markdown 和知识图谱,便于审查和修正
  • 支持本地 LLM,数据不出域,隐私性强
  • 无需额外工具链,CLI 即可完成知识库构建与迭代

不足之处

  • 项目早期,文档和社区生态待观察
  • 对超大文档或复杂格式的处理效率未经验证

适用场景

  • 企业内网知识库搭建与维护
  • 个人笔记系统升级为结构化 Wiki
  • 离线环境下的文档智能整理

替代项目

RAGFlow、Danswer、Quivr

项目介绍

synthadoc 是搜索知识领域的开源项目,由 axoviq-ai 开发,是 2026 年新上线的项目。

在全站 13,090 个收录项目中,它的 GitHub 星标数(1,332)位列前 30%,在搜索知识分类中处于中上游。

近 42 天,它的 GitHub 星标从 970 增加到 1,332,净增 362。

项目目前处于活跃维护状态,最近一次代码更新于 2026-09-23。AGPL-3.0许可,可自行部署使用,无付费版本。

它主要面向的使用场景是:企业内网知识库搭建与维护。同类可对比的替代方案包括 RAGFlow、Danswer、Quivr。

上一篇:nucliadb

下一篇:devdocs

同类项目推荐

firecrawl 开源

网页抓取像喝水一样简单,开发者省下整周加班

The web data API to search, scrape, and interact at scale.

★ 183325 2026-08-09
contoso-chat 开源

一键跑通 Azure RAG 应用,从代码到评估部署全流程

This sample has the full End2End process of creating RAG application with Prompty an···

★ 766 2026-08-09
graphify 开源

整个代码库画成一张图,找问题一眼定位

Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable k···

★ 120493 2026-08-09
ragflow 开源

让大模型用上你的私有知识,搭建可靠的企业级RAG应用

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fu···

★ 91170 2026-08-09