项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 13516
使用教程
环境要求
- Node.js 环境(README 使用 nvm 安装与切换版本)
- pnpm 包管理工具
- Docker(可选,用于容器化部署)
- 推荐使用 Chrome 浏览器获得最佳体验
安装与启动步骤
-
1安装 Node 版本
用 nvm 安装并使用项目指定的 Node 版本,未安装 nvm 需先自行准备。
nvm i && nvm use -
2安装项目依赖
在仓库根目录安装全部依赖,需先克隆项目并进入目录。
pnpm i -
3启动开发模式
启动本地开发服务,启动后浏览器访问 http://localhost:5173/md/ 即可使用编辑器。
pnpm web dev -
4构建生产产物
部署在 /md 路径下用 build,部署在根路径下用 build:h5-netlify,二者按需选择。
pnpm web build pnpm web build:h5-netlify -
5开发浏览器扩展
在 chrome://extensions/ 开启开发者模式,加载 apps/web/.output/chrome-mv3-dev 目录。
pnpm web ext:dev -
6部署到 Cloudflare
分别用于 Cloudflare Workers 的本地开发预览与线上部署。
pnpm web wrangler:dev pnpm web wrangler:deploy -
7CLI 私有化部署
全局安装 @doocs/md-cli 后执行 md-cli 启动,默认监听 8800 端口。
npm i -g @doocs/md-cli md-cli -
8Docker 一键部署
用官方镜像启动容器并映射 8080 端口,镜像详情见 doocs/docker-md 仓库。
docker run -d -p 8080:80 doocs/md:latest
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
port | 否 | md-cli 监听端口,默认 8800,被占用时自动随机选取。 | md-cli port=8899 |
spaceId | 否 | dcloud 服务空间配置,私有化部署时可传。 | spaceId=your-space-id |
clientSecret | 否 | dcloud 服务空间配置,私有化部署时可传。 | clientSecret=your-client-secret |
如何确认成功
浏览器访问 http://localhost:5173/md/,或 Docker 部署后访问 http://localhost:8080,能打开编辑器并即时预览 Markdown 即成功。
常见问题
Q:md-cli 启动时端口被占用怎么办?
A:默认使用 8800 端口,被占用时会自动随机选取一个可用端口;也可用 md-cli port=8899 手动指定端口。
Q:开发模式构建产物部署路径有什么区别?
A:pnpm web build 构建的产物部署在 /md 路径下;pnpm web build:h5-netlify 构建的产物部署在根路径下。
Q:不想本地部署可以直接用吗?
A:可以,官方提供在线编辑器 https://md.doocs.org,推荐使用 Chrome 浏览器以获得最佳体验。
Q:浏览器扩展怎么加载调试?
A:先执行 pnpm web ext:dev,然后在 chrome://extensions/ 开启开发者模式,加载 apps/web/.output/chrome-mv3-dev 目录。
注意事项
- 图床(GitHub、阿里云、腾讯云、七牛云、MinIO、S3、Cloudflare R2 等)与 AI 模型(DeepSeek、OpenAI、通义千问等)需自行在编辑器内配置后使用。
- 登录账户后可同步编辑器偏好,具体见云同步说明文档。
- 项目支持本地草稿管理并自动保存内容,支持文件导入导出。
核心亮点
- 支持多图床(阿里云、腾讯云等),图片上传后自动替换为外链,避免微信图片失效
- 内置多种精美主题,一键切换,复制到公众号后样式保持完整
- 提供内容管理功能,可本地保存多篇草稿,方便写作和归档
不足之处
- 部分高级功能(如 AI 助手)可能需要配置 API Key,对小白用户有一定门槛
- 文档/社区待观察
适用场景
- 微信公众号文章快速排版
- 技术博客内容同步到公众号
- 团队协作撰写微信图文
替代项目
doocs/md、mdnice、wechat-format
上一篇:bili-note
下一篇:open-knowledge
同类项目推荐
Long-Novel-GPT
开源
用 GPT 一口气写完整部长篇小说,告别断更烦恼
该项目包括一个基于 GPT 等大语言模型的长篇小说生成器,同时还有各类小说生成 Prompt 以及···
md-translator
开源
翻译 Markdown 文档,代码公式链接格式全保留
⚡ Translate Markdown without breaking format — code blocks, LaTeX, FrontMatter, li···
agent-style
开源
给 AI 代理装上技术写作规范,输出不再啰嗦。
21 writing rules for AI coding and writing agents. Drop-in for Claude Code, Codex, C···
polywise
开源
让内容活起来,自托管智能代理内容系统
The open source agentic content system to make your contents alive. Self-hosted on a···
shakespeare-writing-studio
开源
让AI写稿更像真人,数据引用有据可查
Agent-ready writing studio for Chinese WeChat articles, English essays, research wri···
PacificOceanAI
开源
在 Overleaf 里一键调用 AI,让 LaTeX 写作和润色不再头疼。
AI-powered writing assistant for Overleaf LaTeX editor - Chrome/Edge extension with ···
unslop
开源
装上它,AI 回复秒变人话,不再满屏破折号和客套话。
Make AI output sound human. Strips AI-isms (sycophancy, stock vocab, hedging stacks,···
WRITING.md
开源
先立写作规矩,AI下笔不跑偏
"Humanizer" rules that make AI text sharper, genre-aware, with concrete anchors and ···
NovelForge
开源
卡片攒素材写长篇,越写越顺不卡壳
AI辅助长篇小说创作,卡片式创作,支持基于 JSON Schema的结构化 AI 生成与上下文引用,可···
