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

#配置

mdocs 没有配置文件。所有配置通过环境变量设置,遵循 12-Factor App 原则。

#完整配置项

环境变量默认值说明
MDOCS_HOST0.0.0.0监听地址(本机仅开发可设为 127.0.0.1)
MDOCS_PORT4000监听端口
MDOCS_WEB_DIST(包内 dist/web)前端静态资源目录;全局 npm install -g 时一般无需设置
MDOCS_DATA_DIR~/.mdocs数据存储根目录
MDOCS_LOG_LEVELinfo日志级别(trace/debug/info/warn/error/fatal/silent)
MDOCS_CONSOLE_LEVELinfo控制台日志级别
MDOCS_CONSOLE_STYLEpretty控制台日志格式(pretty/common/json)
MDOCS_LOG_RETENTION_DAYS14日志保留天数
MDOCS_LOG_MAX_BYTES5242880单个日志文件最大字节数

#使用示例

# 修改端口和数据目录
export MDOCS_PORT=3000
export MDOCS_DATA_DIR=/var/data/mdocs

pnpm start

或者一行启动:

MDOCS_PORT=3000 MDOCS_DATA_DIR=/var/data/mdocs pnpm start

#设计思路

  • 环境变量 > 配置文件:适合容器化部署(Docker/K8s),也适合托管平台(Railway、Fly.io 等)
  • 无 YAML/TOML/JSON 配置:减少一层复杂度和配置校验逻辑