docs
docs/what-is-docs-atlas.md什么是 Docs Atlas
Docs Atlas 是一个以桌面端为主的本地 Markdown 文档聚合阅读器。
它的目标不是做在线协作,也不是做后台内容管理,而是把你分散在不同项目、不同目录中的文档重新组织起来,让阅读、搜索和定位这件事更简单。
为什么这个项目有价值
现实中的开发文档通常会出现这些问题:
- 每个项目都有自己的
docs/ - 设计文档、教程文档、接入说明分散在不同目录
- AI 生成的内容越来越多,但没有统一入口
- 想回头找一篇文档时,不知道它在哪个仓库里
Docs Atlas 的价值就是把这些分散内容聚合成一个统一的阅读入口。
当前项目的形态
当前项目包含两个端:
- 桌面端
- Web 端
但产品重点已经明确转向桌面端。
你可以把它理解成:
- 桌面端是主应用,负责本地知识库管理和长期使用
- Web 端是补充能力,负责预览、静态部署和只读分享
它适合谁
Docs Atlas 适合这些人:
- 有多个项目文档需要统一查看的开发者
- 会长期积累本地 Markdown 知识库的人
- 希望把 AI 生成文档沉淀下来的人
- 想给团队提供统一文档阅读入口的人
它解决什么问题
Docs Atlas 重点解决四类问题:
- 文档分散
- 阅读入口不统一
- 搜索范围被项目边界切断
- 文档生成容易,复用和回看困难
它通过下面这些能力来解决:
- 多目录聚合
- 统一目录导航
- 全文搜索
- 工作空间隔离
- 统一的 Markdown 阅读体验
核心内容规则
无论是桌面端还是 Web 端,文档规则都保持一致:
- 一级目录视为专题
- 专题下的
README.md是入口页 - 其他 Markdown 视为正文文档
- 根目录下直接放置的 Markdown 会直接显示为文档项
- 图片相对路径按文档所在目录解析
为什么这篇文档放在根目录
这篇文件故意放在 docs/ 根目录,而不是放进某个专题目录里。
它用来演示一个规则:
- 如果文档源根目录下直接放置 Markdown
- 它会作为独立文档直接显示
- 不会再被额外包成一层专题
这对项目总览、索引说明、聚合入口这类文档很有用。