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
Md
这是什么？doocs/md 是一款 WeChat Markdown 编辑器，它能将你的 Markdown 即时渲染为整洁、可直接粘贴的微信公众号文章格式，让你无需在微信编辑器里手动重新调整排版。
这是网页编辑器，还是需要安装的软件？这是一款基于 Vue3 和 TypeScript 构建的网页编辑器，可以在线使用；同时也提供 npm CLI 和 Docker 镜像用于自托管，此外同一个 monorepo 中还附带独立的 VS Code 扩展和 MCP 服务器。
我该如何开始使用，或运行自己的实例？直接打开在线编辑器（推荐使用 Chrome）即可开始输入 Markdown；如需自托管，运行 npm CLI 并加上 'port'、'spaceId' 和 'clientSecret' 参数，或部署提供的 Docker 镜像。
写作前是否需要设置图床或 AI API 密钥？不需要，默认图床开箱即用，但你也可以接入 GitHub、Aliyun OSS、Tencent COS、Qiniu Kodo、MinIO、S3、Cloudflare R2、Telegram 或 Cloudinary。AI 写作辅助功能则需要你自己的密钥，支持 DeepSeek、OpenAI、Qwen、Tencent Hunyuan、Volcano Ark 或 302.AI 等模型。
图床或同步设置有什么需要注意的吗？大多数图床服务商（Aliyun、Tencent、Qiniu、MinIO、S3、R2、WeChat official account 等）都需要你填写自己的访问密钥、存储桶和域名信息；编辑器偏好设置只有在登录账户后才会在多台设备之间同步。
作者为什么要自己开发，而不直接使用现有的 WeChat Markdown 编辑器？现有的开源 WeChat Markdown 编辑器往往样式混乱、风格不统一，需要不断手动调整，因此作者开发了 doocs/md，让写作者专注于内容，而不必与排版较劲。
除了基础语法，它还支持哪些特殊的 Markdown 语法？除标准 Markdown 外，它还支持通过 KaTeX 渲染的数学公式、Mermaid 图表、PlantUML、GitHub 风格的提示框（GFM），以及写作为 '[text]{ruby}' 或 '[text]^(ruby)' 的 Ruby 注音标注。
它是否包含 VS Code 扩展或 MCP 服务器？包含。该 monorepo 在主网页编辑器、CLI 和 API 之外，还附带了一个 VS Code 扩展和一个 MCP 服务器包。
What are similar projects?huobao-drama, chatgpt-web, Mars-Editor-Web, md2wechat-skill, marp, rankme.fast, taro, TradingAgents-CN
Which topics is it in?weixin, markdown-editor, vue3, vscode-extension, ai-assistant, wechat, content-creation, tailwindcss, editor, vite, vue, deepseek
Creator
doocs
Size
47.2 MB
Stars
13.4K
Updated
CommitOct 12Releasev2.1.0Oct 17
Age
6y
Commits · 90 Days