微信Markdown编辑器 v1.6.0.zip

<div align="center"> [](https://github.com/doocs/md) </div> <h1 align="center">微信 Markdown 编辑器</h1> <div align="center"> [](https://github.com/doocs/md/actions) [](https://github.com/doocs/md/actions) [](https://github.com/doocs/md/actions) [](#谁在使用) [](../../pulls)<br> [](https://github.com/doocs/md) [](https://gitee.com/doocs/md) [](./LICENSE) [](../../releases) </div> ## 项目介绍 > 本项目基于 [wechat-format](https://github.com/lyricat/wechat-format) 进行二次开发，感谢 [lyricat](https://github.com/lyricat) 的创意和贡献！ Markdown 文档自动即时渲染为微信图文，让你不再为微信文章排版而发愁！只要你会基本的 Markdown 语法，就能做出一篇样式简洁而又美观大方的微信图文。 ## 在线编辑器地址 - Gitee Pages：https://doocs.gitee.io/md - GitHub Pages：https://doocs.github.io/md 注：推荐使用 Chrome 浏览器，效果最佳。另外，对于国内（中国）的朋友，访问 [Gitee Pages](https://doocs.gitee.io/md) 速度会相对快一些。 ## 为何二次开发 现有的开源微信 Markdown 编辑器，样式繁杂，也不符合我个人的审美需求。在我使用它们进行文章排版的时候，经常还要自己做一些改动，费时费力，因此动手做了二次开发。 欢迎各位朋友随时提交 PR，让这款微信 Markdown 编辑器变得更好！如果你有新的想法，也欢迎在 [Discussions 讨论区](https://github.com/doocs/md/discussions)反馈。 ## 功能特性 - [x] 支持自定义 CSS 样式 - [x] 支持 Markdown 所有基础语法 - [x] 支持浅色、暗黑两种主题模式 - [x] 支持 <kbd>Ctrl</kbd> + <kbd>F</kbd> 快速格式化文档 - [x] 支持色盘取色，快速替换文章整体色调 - [x] 支持多图上传，可自定义配置图床 - [x] 支持自定义上传逻辑 - [x] 支持在编辑框右键弹出功能选项卡 - [x] 支持批量转换本地图片为线上图片 ## 目前支持哪些图床 | # | 图床 | 使用时是否需要配置 | 备注 | | --- | ----------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | 1 | 默认 | 否 | - | | 2 | [GitHub](https://github.com) | 配置 `Repo`、`Token` 参数 | [如何获取 GitHub token？](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) | | 3 | [阿里云](https://www.aliyun.com/product/oss) | 配置 `AccessKey ID`、`AccessKey Secret`、`Bucket`、`Region` 参数 | [如何使用阿里云 OSS？](https://help.aliyun.com/document_detail/31883.html) | | 4 | [腾讯云](https://cloud.tencent.com/act/pro/cos) | 配置 `SecretId`、`SecretKey`、`Bucket`、`Region` 参数 | [如何使用腾讯云 COS？](https://cloud.tencent.com/document/product/436/38484) | | 5 | [七牛云](https://www.qiniu.com/products/kodo) | 配置 `AccessKey`、`SecretKey`、`Bucket`、`Domain`、`Region` 参数 | [如何使用七牛云 Kodo？](https://developer.qiniu.com/kodo) | | 6 | [MinIO](https://min.io/) | 配置 `Endpoint`、`Port`、`UseSSL`、`Bucket`、`AccessKey`、`SecretKey` 参数 | [如何使用 MinIO？](http://docs.minio.org.cn/docs/master/minio-client-complete-guide) | | 7 | 自定义上传 | 是 | [如何自定义上传？](#自定义上传逻辑) |     ## 注意事项 1. 如果你使用了某些浏览器脚本修改了网页背景色，可能导致渲染后的文章出现背景色分块的现象，详见 [#63](https://github.com/doocs/md/issues/63)。 2. 某些浏览器插件，会对文章样式造成破坏。现象是：复制粘贴到公众号后台文章，点击保存时，样式丢失，详见 [#151](https://github.com/doocs/md/issues/151)。 ## 自定义上传逻辑 在工具上没有提供预定义图床的情况下，你只需要自定义上传逻辑即可，这对于例如你不方便使用公共图床，而是使用自己的上传服务时非常有用。 你只需要在给定的函数中更改上传代码即可，为了方便，这个函数提供了可能使用的一些参数： 示例代码： ```js const { file, util, okCb, errCb } = CUSTOM_ARG; const param = new FormData(); param.append("file", file); util.axios .post("http://127.0.0.1:9000/upload", param, { headers: { "Content-Type": "multipart/form-data" }, }) .then((res) => { okCb(res.url); }) .catch((err) => { errCb(err); }); // 提供的可用参数: // CUSTOM_ARG = { // content, // 待上传图片的 base64 // file, // 待上传图片的 file 对象 // util: { // axios, // axios 实例 // CryptoJS, // 加密库 // OSS, // ali-oss // COS, // cos-js-sdk-v5 // Buffer, // buffer-from // uuidv4, // uuid // qiniu, // qiniu-js // tokenTools, // 一些编码转换函数 // getDir, // 获取 年/月/日 形式的目录 // getDateFilename, // 根据文件名获取它以 时间戳+uuid 的形式 // }, // okCb: resolve, // 重要！上传成功后给此回调传 url 即可 // errCb: reject, // 上传失败调用的函数 // } ``` 如果你创建了适用于其他第三方图床的上传代码，我们非常欢迎你分享它。 ## 如何开发和部署 ```sh # 安装依赖 npm i # 启动开发模式 npm start # 部署在 /md 目录 npm run build # 访问 http://127.0.0.1:9000/md # 部署在根目录 npm run build:h5-netlify # 访问 http://127.0.0.1:9000/ ``` ## 快速搭建私有服务 ### 方式 1. 使用 npm cli 通过我们的 npm cli 你可以轻易搭建属于自己的微信 Markdown 编辑器。 ```sh # 安装 npm i -g @doocs/md-cli # 启动 md-cli # 访问 open http://127.0.0.1:8800/md/ # 启动并指定端口 md-cli port=8899 # 访问 open http://127.0.0.1:8899/m