mirror of
https://github.com/doocs/md.git
synced 2024-11-24 19:10:34 +08:00
docs: update README
更新 README 文档说明
This commit is contained in:
parent
50b8c662de
commit
82bb1430bf
32
README.md
32
README.md
@ -1,18 +1,32 @@
|
||||
# Wechat Markdown Editor
|
||||
# 微信 Markdown 编辑器
|
||||
[![github](https://badgen.net/badge/⭐/GitHub/cyan)](https://github.com/cseye/md) [![gitee](https://badgen.net/badge/⭐/Gitee/cyan)](https://gitee.com/cseye/md) [![license](https://badgen.net/github/license/cseye/md)](./LICENSE)
|
||||
|
||||
> Clone from https://github.com/zkqiang/wechat-mdeditor
|
||||
本项目基于 [wechat-format](https://github.com/lyricat/wechat-format) 进行二次开发,感谢 [lyricat](https://github.com/lyricat) 的创意和贡献!
|
||||
|
||||
See the [中文文档](README_CN.md) for Chinese README.
|
||||
## 编辑器地址
|
||||
欢迎使用本微信 Markdown 编辑器进行排版。
|
||||
|
||||
## Site
|
||||
- GitHub Page: https://cseye.github.io/md
|
||||
- Gitee Page: https://cseye.gitee.io/md
|
||||
- GitHub Page:https://cseye.github.io/md
|
||||
- Gitee Page:https://cseye.gitee.io/md
|
||||
|
||||
Maybe you can visit [Gitee Page](https://cseye.gitee.io/md) for a better experience.
|
||||
注:对于国内(中国)的朋友,访问 Gitee Page 速度会相对快一些。
|
||||
|
||||
## Official Account
|
||||
You can use wechat and scan the qrcode to follow me.
|
||||
## 为何二次开发
|
||||
现有的开源微信 Markdown 编辑器,样式繁杂,也不符合我个人的审美需求。在我使用它们进行文章排版的时候,经常还要自己做一些改动,费时费力,因此动手做了二次开发。
|
||||
|
||||
## 功能特性
|
||||
- [x] 支持 Markdown 所有基础语法
|
||||
- [x] 支持单独进行字体、字号设置
|
||||
- [x] 支持色盘取色,并一键替换颜色(亮点)
|
||||
- [x] 支持链接微信图文,外链自动转为文末索引
|
||||
- [x] 支持一键复制并粘贴到公众号后台
|
||||
|
||||
![select-and-replace-color-theme](./assets/images/select-and-replace-color-theme.gif)
|
||||
|
||||
![copy-and-paste](./assets/images/copy-and-paste.gif)
|
||||
|
||||
## 我的公众号
|
||||
欢迎微信扫码关注我的公众号“Doocs开源社区”,原创技术文章第一时间推送。
|
||||
|
||||
<div style="text-align:center;">
|
||||
<img src="./assets/images/qrcode.jpg" width="200px;"/>
|
||||
|
28
README_CN.md
28
README_CN.md
@ -1,28 +0,0 @@
|
||||
# 微信 Markdown 编辑器
|
||||
[![github](https://badgen.net/badge/⭐/GitHub/cyan)](https://github.com/cseye/md) [![gitee](https://badgen.net/badge/⭐/Gitee/cyan)](https://gitee.com/cseye/md) [![license](https://badgen.net/github/license/cseye/md)](./LICENSE)
|
||||
|
||||
本项目克隆自 https://github.com/zkqiang/wechat-mdeditor ,感谢 [zkqiang](https://github.com/zkqiang) 定义的基础 CSS 样式。
|
||||
|
||||
英文文档请看 [README](README.md)。
|
||||
|
||||
## 在线编辑器
|
||||
- GitHub Page:https://cseye.github.io/md
|
||||
- Gitee Page:https://cseye.gitee.io/md
|
||||
|
||||
注:对于国内(中国)的朋友,访问 Gitee Page 速度会相对快一些。
|
||||
|
||||
## 为什么要二次改造?
|
||||
每个人的审美都不一样,我希望能在基础 CSS 样式的基础上进行改造,定义一款高度简洁的微信 Markdown 编辑器。
|
||||
|
||||
## 功能特性
|
||||
- [x] 支持所有基础 Markdown 语法
|
||||
- [x] 支持单独进行字体、字号设置
|
||||
- [x] 支持色盘取色,并一键替换颜色
|
||||
- [x] 支持链接微信图文,外链自动转换为索引并在文末引用
|
||||
|
||||
## 我的公众号
|
||||
微信扫码关注我的公众号“Doocs开源社区”,原创技术文章第一时间推送。
|
||||
|
||||
<div style="text-align:center;">
|
||||
<img src="./assets/images/qrcode.jpg" width="200px;"/>
|
||||
</div>
|
BIN
assets/images/copy-and-paste.gif
Normal file
BIN
assets/images/copy-and-paste.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.9 MiB |
BIN
assets/images/select-and-replace-color-theme.gif
Normal file
BIN
assets/images/select-and-replace-color-theme.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.6 MiB |
Loading…
Reference in New Issue
Block a user