logo
mdocs
首页
特性
开始
文档
GitHub
首页
特性
开始
文档
GitHub
logo
mdocs

快速开始

安装
第一个知识库

AI 与 Agent

智能助手(AI)
Agent 开发闭环
CLI Token

核心概念

所见皆文件
工作空间
文档级邀请
无账户身份识别

使用指南

设置页面概览
Markdown 编辑
HTML 文档
流程图生成
知识图谱
草稿与同步
我的文章与邀请
文档收藏
文档评论
受限工作空间成员与模板
恢复码(兼容)

部署与配置

环境要求
配置文件
反向代理示例
客户端壳(Android / 桌面)
FAQ
更新日志
Previous PageCLI Token
Next Page工作空间
mdocs

Write freely. Never lose a word.

MIT License
产品
功能特性Agent 开发闭环竞品对比更新日志
资源
文档安装指南
社区
GitHub问题反馈
© 2026 mdocs · Made with ♥ by xuhuafeifei

#所见皆文件

mdocs 的存储模型将文档目录树映射为两层结构:

  • SQLite 维护逻辑关系(父子、权限、元数据)
  • 文件系统 存储实际内容(Markdown / Lexical JSON)

#逻辑结构

documents 表中的每行记录代表一个节点:

file_type含义relative_pathparent_id
dir目录工作空间内相对路径(如 folder/sub)指向父目录的 document_id
md文档完整路径(如 folder/sub/a.md)指向父目录的 document_id

目录树由 parent_id 关系直接确定,不依赖路径切割。

#物理存储

文档内容以 Lexical JSON 格式写入磁盘:

~/.mdocs/files/docs/{domain_id}/folder/sub/a.md
  • {domain_id} 是工作空间的唯一标识,每个工作空间拥有独立的磁盘子目录
  • 磁盘路径与 relative_path 一一对应
  • 目录节点(file_type = 'dir')不写磁盘文件,仅存在于数据库中

#目录描述

每个目录可以附带一个 ___desc___.md 文件:

  • 路径为 {dirPath}/___desc___.md
  • parent_id 指向该目录的 document_id
  • 前端用其内容作为目录描述展示
  • v0.8.5+:与普通 .md 文档相同,拥有 headCommitId 与发布版本链;编辑目录描述后可正常发布

#设计意图

  • SQLite 管理逻辑结构(谁是父目录、谁有权限)
  • 文件系统管理实际数据(Markdown / JSON 内容)
  • 工作空间之间在磁盘上完全隔离,不同工作空间可以拥有同名文件