WeChat Markdown 编辑器使用教程

1. 项目介绍

WeChat Markdown 编辑器是一款简洁优雅的Markdown编辑器，专为微信内容排版设计。它支持Markdown所有基础语法，提供数学公式、Mermaid图表渲染、GFM警告块等功能，以及丰富的代码块高亮主题。用户可以自定义主题色和CSS样式，支持多图上传，并提供草稿自动保存等便捷功能。

2. 项目快速启动

环境准备

确保已经安装了Node.js环境。

安装依赖

npm i

启动开发模式

npm start

启动后，可以通过浏览器访问 http://127.0.0.1:9000/md 查看编辑器。

构建部署

构建项目到 /md 目录：

npm run build

构建完成后，可以部署到服务器，并通过 http://127.0.0.1:9000/md 访问。

如果需要部署到根目录，可以使用以下命令：

npm run build:h5-netlify

然后通过 http://127.0.0.1:9000/ 访问。

使用npm cli快速搭建

安装全局npm cli：

npm i -g @doocs/md-cli

启动编辑器：

md-cli

启动后，可以通过浏览器访问 http://127.0.0.1:8800/md/。

使用Docker镜像

运行以下命令启动Docker实例：

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

容器运行后，通过浏览器访问 http://localhost:8080。

3. 应用案例和最佳实践

• 自定义主题：通过编辑CSS样式，打造个性化的Markdown编辑器。
• 集成图床：配置并使用GitHub、阿里云、腾讯云等图床，实现图片一键上传。
• 代码块高亮：选择合适的代码块高亮主题，提升代码可读性。

4. 典型生态项目

WeChat Markdown 编辑器可以被用于构建个人博客、团队知识库、在线课程等。它支持与多种服务集成，如GitHub、Netlify等，可以轻松嵌入到现有的Web项目中，提供强大的Markdown编辑能力。