mirror of
https://github.com/doocs/md.git
synced 2024-11-24 19:10:34 +08:00
2d40869fc2
* refactor: renderer upgrade to ts * fix: options of katex * fix: render of katex * chore: update marked-katex-extension to version 5.1.2 * chore: build theme * chore: update renderer * feat: move build addition func * chore: styled content * chore: update renderer * chore: update packages * chore: update renderer * fix: logic of merged * chore: update renderer * chore: update * feat: add token type * feat: add styles func * chore: update renderer * fix: parse table cell * feat: horizontal table scrolling is supported * fix: strong tag * feat: parse strong and em label * fix: parse list * chore: update example docs * chore: update --------- Co-authored-by: Libin YANG <szuyanglb@outlook.com>
216 lines
11 KiB
Markdown
216 lines
11 KiB
Markdown
<div align="center">
|
||
|
||
[](https://github.com/doocs/md)
|
||
|
||
</div>
|
||
|
||
<h1 align="center">微信 Markdown 编辑器</h1>
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/doocs/md/actions) [](https://nodejs.org/en/about/previous-releases) [](https://github.com/doocs/md/releases) [](./LICENSE) [](https://github.com/doocs/md/pulls)<br>[](https://github.com/doocs/md/stargazers) [](https://github.com/doocs/md)
|
||
|
||
</div>
|
||
|
||
## 项目介绍
|
||
|
||
Markdown 文档自动即时渲染为微信图文，让你不再为微信文章排版而发愁！只要你会基本的 Markdown 语法，就能做出一篇样式简洁而又美观大方的微信图文。
|
||
|
||
## 在线编辑器地址
|
||
|
||
[https://doocs.github.io/md](https://doocs.github.io/md)
|
||
|
||
注：推荐使用 Chrome 浏览器，效果最佳。
|
||
|
||
## 为何二次开发
|
||
|
||
现有的开源微信 Markdown 编辑器，样式繁杂，也不符合我个人的审美需求。在我使用它们进行文章排版的时候，经常还要自己做一些改动，费时费力，因此动手做了二次开发。
|
||
|
||
欢迎各位朋友随时提交 PR，让这款微信 Markdown 编辑器变得更好！如果你有新的想法，也欢迎在 [Discussions 讨论区](https://github.com/doocs/md/discussions)反馈。
|
||
|
||
注：我们项目最新版本基于 Vue3 开发，基于 Vue2 的旧版本已经不再维护，如果你需要 Vue2 版本，请切换到 [1.x](https://github.com/doocs/md/tree/1.x) 分支。
|
||
|
||
## 功能特性
|
||
|
||
- [x] 支持自定义 CSS 样式
|
||
- [x] 支持 Markdown 所有基础语法
|
||
- [x] 支持浅色、深色两种编辑器外观
|
||
- [x] 支持 <kbd>Alt</kbd> + <kbd>Shift</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, // tiny-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/md/
|
||
```
|
||
|
||
md-cli 支持以下命令行参数：
|
||
|
||
- `port` 指定端口号，默认 8800，如果被占用会随机使用一个新端口。
|
||
- `spaceId` dcloud 服务空间配置
|
||
- `clientSecret` dcloud 服务空间配置
|
||
|
||
### 方式 2. 使用 Docker 镜像
|
||
|
||
如果你是 Docker 用户，也可以直接使用一条命令，启动完全属于你的、私有化运行的实例。
|
||
|
||
```sh
|
||
docker run -d -p 8080:80 doocs/md:latest
|
||
```
|
||
|
||
容器运行起来之后，打开浏览器，访问 http://localhost:8080 即可。
|
||
|
||
关于本项目 Docker 镜像的更多详细信息，可以关注 https://github.com/doocs/docker-md
|
||
|
||
## 谁在使用
|
||
|
||
- [Doocs](https://mp.weixin.qq.com/s/RNKDCK2KoyeuMeEs6GUrow)
|
||
- [ApachePulsar](https://mp.weixin.qq.com/s/udU2ZICg60HbspgWTQdYpg)
|
||
- [码云 Gitee](https://mp.weixin.qq.com/s/bnlWqzCarDlR4F27HHXNUg)
|
||
- [掘墓人的小铲子](https://mp.weixin.qq.com/s/FpGIX9viQR6Z9iSCEPH86g)
|
||
- [全网重点](https://mp.weixin.qq.com/s/yB3ZH3jmcF_LbzuKmnR9BQ)
|
||
- [爱码士的内心独白](https://mp.weixin.qq.com/s/oc5Z2t9ykbu_Dezjnw5mfQ)
|
||
- [乐玩 nodejs npm 工具库](https://mp.weixin.qq.com/s/SFde8OsZ8FzNGMHwpmDtrg)
|
||
- [简静慢](https://mp.weixin.qq.com/s/7UG24ZugfI5ZnhUpo8vfvQ)
|
||
- [0 加 1](https://mp.weixin.qq.com/s/qefHCmToAdowBz2JwBn_ug)
|
||
- [编程图解](https://mp.weixin.qq.com/s/7bfpKACg7HP-PhBrkpM9IQ)
|
||
- [好酸一柠檬](https://mp.weixin.qq.com/s/CVqmcu_OGG8TQO4FViAQ3w)
|
||
- [不知所云 Hub](https://mp.weixin.qq.com/s/leDCdpvnfk8eZRPRRHwg5w)
|
||
- [会泽百家](https://mp.weixin.qq.com/s/c9ZXxQHCrKz1FP1Zbh1S1w)
|
||
- [平凡而诗意](https://mp.weixin.qq.com/s/MV8ch6qlSsamSaBOhWr9kg)
|
||
- [治恒说说](https://mp.weixin.qq.com/s/bWPKO-S3TNLsCgzwspHCTg)
|
||
- [柯宁申的叙事屋](https://mp.weixin.qq.com/s/AHHrxu7aIYBpvn3PpVHE_Q)
|
||
- [我的 Beta 世界](https://mp.weixin.qq.com/s/6BO977YG5e_4qYxL4oVQJw)
|
||
- [生化环材](https://mp.weixin.qq.com/s/fqNxIRxTkn6QEPmi4atW9w)
|
||
- [秀宇笔记](https://mp.weixin.qq.com/s/VUlOBFA93eiqZ5ZYGmXzmQ)
|
||
- [IT 王小二](https://mp.weixin.qq.com/s/UU3cH8LvpO_3aeAkkYvZZQ)
|
||
- [小二来碗饭](https://mp.weixin.qq.com/s/49wUuhOEYG-OZPbFc6_NrQ)
|
||
- [青年技术宅](https://mp.weixin.qq.com/s/YDUZ0t_spzeqXiE_Idv3OA)
|
||
- [路引科研](https://mp.weixin.qq.com/s/oinGHCmer1vNE6Hg2OsH1g)
|
||
- [凯文有事找你](https://mp.weixin.qq.com/s/ap_JhwgmfxgqFAIcTF3nKQ)
|
||
- [软件部落库](https://mp.weixin.qq.com/s/itkJtMY-1IkZjIn5fWtShw)
|
||
- [网文小密圈](https://mp.weixin.qq.com/s/_44Ya309DeQzemXLnJUNdQ)
|
||
- [潇洒哥和黑大帅](https://mp.weixin.qq.com/s/k9WbW0zmxl0S2WX2CXQ6cQ)
|
||
- [云原生指北](https://mp.weixin.qq.com/s/qFQBBpjUoqdfnmCeOGqRJQ)
|
||
- [全栈民工](https://mp.weixin.qq.com/s/i7hTPuuJAtcK9G55tep0Uw)
|
||
- [睡不醒的鲤鱼](https://mp.weixin.qq.com/s/14HNDbDIvfDnV7ePEfbyuQ)
|
||
- [Dmego](https://mp.weixin.qq.com/s/4QeZsTL84lbN_HO3kCwEwg)
|
||
- [红岸](https://mp.weixin.qq.com/s/_cNyKqRr8E1ENg9r7IO70Q)
|
||
- [HelloCoder](https://mp.weixin.qq.com/s/ekCoyhT-JjbYsysKBgdJzQ)
|
||
- [前端黑板报](https://mp.weixin.qq.com/s/bnZebWPd5-TgiXgQVUKdaQ)
|
||
- [Web3HackerWorld](https://mp.weixin.qq.com/s/eLuC6e93RR1zCD3w2FgpVA)
|
||
- [StruggleYang](https://mp.weixin.qq.com/s/fKKQrsatC9en3PwWiCL-KQ)
|
||
- [比心技术](https://mp.weixin.qq.com/s/DYzzci2paf10CgW22pkyUQ)
|
||
|
||
注：如果你使用了本 Markdown 编辑器进行文章排版，并且希望在本项目 README 中展示你的公众号，请到 [#5](https://github.com/doocs/md/discussions/5) 留言。
|