md README

The project's README from github.com/doocs/md. As one markdown file: README.md.

doocs-md

微信 Markdown 编辑器

status node pr stars forks
release npm docker

中文 | English

项目介绍

Markdown 文档自动即时渲染为微信图文,让你不再为公众号排版发愁。只需掌握基本的 Markdown 语法,即可生成样式简洁、美观大方的微信图文。

如果这个项目对你有帮助,欢迎点个 Star ⭐️,我们会持续维护与迭代。

在线编辑器

https://md.doocs.org

推荐使用 Chrome 浏览器以获得最佳体验。

为何开发这款编辑器

现有的开源微信 Markdown 编辑器普遍存在样式繁杂、排版需反复调整的问题。本项目致力于提供一个更简洁、易用的编辑器,让内容创作者专注于写作本身,而非排版细节。

欢迎随时提交 PR 参与共建,也欢迎在 Discussions 中分享你的想法。

功能特性

支持的图床服务

# 图床 使用时是否需要配置 备注
1 默认 否 -
2 GitHub 配置 Repo、Token 参数 如何获取 GitHub token?
3 阿里云 配置 AccessKey ID、AccessKey Secret、Bucket、Region 参数 如何使用阿里云 OSS?
4 腾讯云 配置 SecretId、SecretKey、Bucket、Region 参数 如何使用腾讯云 COS?
5 七牛云 配置 AccessKey、SecretKey、Bucket、Domain、Region 参数 如何使用七牛云 Kodo?
6 MinIO 配置 Endpoint、Port、UseSSL、Bucket、AccessKey、SecretKey 参数 如何使用 MinIO?
7 S3 协议 配置 Endpoint、Region、Bucket、AccessKey、SecretKey 参数 支持 AWS S3、Oracle、DigitalOcean 等兼容 S3 的存储服务
8 公众号 配置 appID、appsecret、代理域名 参数 如何使用公众号图床?
9 Cloudflare R2 配置 AccountId、AccessKey、SecretKey、Bucket、Domain 参数 如何使用 S3 API 操作 R2?
10 又拍云 配置 Bucket、Operator、Password、Domain 参数 如何使用 又拍云?
11 Telegram 配置 Bot Token、Chat ID 参数 如何使用 Telegram 图床?
12 Cloudinary 配置 Cloud Name、API Key、API Secret 参数 如何使用 Cloudinary?
13 自定义上传 是 如何自定义上传?

产品演示

主题切换 图片上传
demo1 demo2
样式扩展 一键排版
demo3 demo4

开发与部署

# 安装 Node 版本
nvm i && nvm use

# 安装依赖
pnpm i

# 启动开发模式,访问 http://localhost:5173/md/
pnpm web dev

# 构建,部署在 /md 路径下
pnpm web build

# 构建,部署在根路径下
pnpm web build:h5-netlify

# Chrome 扩展开发模式
# 启动后在 chrome://extensions/ 开启开发者模式,加载 apps/web/.output/chrome-mv3-dev 目录
pnpm web ext:dev

# 打包 Chrome 扩展
pnpm web ext:zip

# 打包 Firefox 扩展,输出至 apps/web/.output/md-{version}-firefox.zip
pnpm web firefox:zip

# 打包 uTools 插件,输出至 apps/utools/release/md-utools-v{version}.zip
pnpm utools:package

# Cloudflare Workers 开发与部署
pnpm web wrangler:dev
pnpm web wrangler:deploy

私有化部署

方式一:npm cli

# 全局安装
npm i -g @doocs/md-cli

# 启动(默认端口 8800)
md-cli

# 指定端口启动
md-cli port=8899

支持的命令行参数:

方式二:Docker

docker run -d -p 8080:80 doocs/md:latest

启动后访问 http://localhost:8080 即可。Docker 镜像的更多信息,请参考 https://github.com/doocs/docker-md

Star 趋势

Stargazers over time

谁在使用

请查看 USERS.md,了解使用本项目的公众号列表。

参与贡献

欢迎提交 PR 或 Issue,请参阅 CONTRIBUTING.md 了解贡献流程与规范。

支持我们

如果本项目对你有所帮助,欢迎通过以下方式支持我们持续维护。

support1
support2

反馈与交流

使用中遇到问题或有功能建议,欢迎在 Issues 中反馈。也可扫码加入微信交流群,若二维码失效,请添加好友并备注 md。

doocs-md-wechat-group
wechat-ylb

md (doocs/md)

Searching Database…

13.4K ·GitHub
What is this?doocs/md is a WeChat Markdown editor that instantly renders your Markdown into clean, ready-to-paste WeChat Official Account article formatting, so you do not have to manually re-style posts in the WeChat editor.
Is this a browser-based editor or something I install?It is a web-based editor built with Vue3 and TypeScript that you can use online; it also ships an npm CLI and a Docker image for self-hosting, plus a separate VS Code extension and MCP server in the same monorepo.
How do I start using it, or run my own instance?Just open the online editor (Chrome recommended) and start typing Markdown; to self-host, run the npm CLI with 'port', 'spaceId' and 'clientSecret' flags, or deploy the provided Docker image.
Do I need to set up an image host or AI API key before writing?No, a default image host works out of the box, but you can plug in GitHub, Aliyun OSS, Tencent COS, Qiniu Kodo, MinIO, S3, Cloudflare R2, Telegram or Cloudinary. AI writing assistance needs your own key for models like DeepSeek, OpenAI, Qwen, Tencent Hunyuan, Volcano Ark or 302.AI.
Any catch with image hosting or syncing my settings?Most image-host providers (Aliyun, Tencent, Qiniu, MinIO, S3, R2, WeChat official account, etc.) require you to fill in your own access keys, bucket and domain details, and editor preferences only sync across devices if you log into an account.
Why did the author build this instead of using an existing WeChat Markdown editor?Existing open-source WeChat Markdown editors tend to have messy, inconsistent styling that needs constant manual tweaking, so the author built doocs/md to let writers focus on content instead of fighting layout.
What special Markdown syntax does it support beyond the basics?Besides standard Markdown it supports math formulas via KaTeX, Mermaid diagrams, PlantUML, GitHub-style alert blocks (GFM), and Ruby annotations written as '[text]{ruby}' or '[text]^(ruby)'.
Does it include a VS Code extension or MCP server?Yes, the monorepo bundles a VS Code extension and an MCP server package alongside the main web editor, CLI and API.
Creator
doocs
Size
47.2 MB
Stars
13.4K
Age
6y
Commits · 90 Days