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

快速开始

安装
第一个知识库

AI 与 Agent

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

核心概念

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

使用指南

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

部署与配置

环境要求
配置文件
反向代理示例
客户端壳(Android / 桌面)
FAQ
更新日志
Previous Page恢复码(兼容)
Next Page配置文件
mdocs

Write freely. Never lose a word.

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

#环境要求

#运行时

资源要求
运行时Node.js 22+
包管理器pnpm(推荐)
CPU1 核(开发/小团队够用)
内存运行约 512 MB 以上;安装阶段建议 ≥1G 或配置 Swap(见小服务器安装)
磁盘视文档量而定

#依赖

  • 无外部服务依赖:不需要安装数据库、缓存、消息队列等中间件
  • SQLite:内嵌在 better-sqlite3 中,零配置
  • 文档存储:直接使用文件系统

#存储布局

运行时数据集中存储在 ~/.mdocs/ 目录下:

~/.mdocs/
  sqlite/
    data.sqlite       # 元数据(文档索引、访客、权限、审计日志)
  files/
    docs/
      {domain_id}/    # 每个工作空间独立的子目录
        a.md          # 工作空间内文档(Lexical JSON 格式)
    assets/           # 上传的附件
  logs/               # 运行日志(按日期轮转)

可通过环境变量 MDOCS_DATA_DIR 自定义数据目录位置。

#网络

  • 默认监听 0.0.0.0:4000(所有网卡,适合服务器直接暴露或通过反向代理)
  • 本地开发若只想本机访问:export MDOCS_HOST=127.0.0.1
  • 生产部署仍建议通过反向代理对外暴露(见反向代理)