md/README.md

97 lines
4.8 KiB
Markdown
Raw Normal View History

<p align="center">
<a href="https://github.com/doocs/md">
<img src="./assets/images/logo-2.png">
</a>
</p>
<h1 align="center">微信 Markdown 编辑器</h1>
2019-11-01 20:08:07 +08:00
<div align="center">
[![github](https://badgen.net/badge/⭐/GitHub/cyan)](https://github.com/doocs/md) [![gitee](https://badgen.net/badge/⭐/Gitee/cyan)](https://gitee.com/doocs/md) [![PRs Welcome](https://badgen.net/badge/PRs/welcome/green)](../../pulls) [![users](https://badgen.net/badge/who's/using/green)](../../issues) [![license](https://badgen.net/github/license/doocs/md)](./LICENSE) [![release](https://img.shields.io/github/v/release/doocs/md.svg)](../../releases)
</div>
## 项目介绍
> 本项目基于 [wechat-format](https://github.com/lyricat/wechat-format) 进行二次开发,感谢 [lyricat](https://github.com/lyricat) 的创意和贡献!
2019-11-04 09:41:02 +08:00
Markdown 文档自动即时渲染为微信图文,让你不再为微信文章排版而发愁!只要你会基本的 Markdown 语法,就能做出一篇样式简洁而又美观大方的微信图文。
2019-11-01 17:34:00 +08:00
## 在线编辑器地址
- GitHub Pagehttps://doocs.github.io/md
- Gitee Pagehttps://doocs.gitee.io/md
2019-11-01 18:28:26 +08:00
注:推荐使用 Chrome 浏览器,效果最佳。另外,对于国内(中国)的朋友,访问 [Gitee Page](https://doocs.gitee.io/md) 速度会相对快一些。
2019-11-01 18:28:26 +08:00
## 为何二次开发
现有的开源微信 Markdown 编辑器,样式繁杂,也不符合我个人的审美需求。在我使用它们进行文章排版的时候,经常还要自己做一些改动,费时费力,因此动手做了二次开发。
欢迎各位朋友随时提交 PR让这款微信 Markdown 编辑器变得更好!如果你有新的想法,也欢迎在 Issues 区反馈。
注:目前在非 master 分支上对项目进行重构,更多新特性,敬请期待!
- [Vue 分支](https://github.com/doocs/md/tree/m_create_vue)
- [React 分支](https://github.com/doocs/md/tree/chore-webpack)
2020-01-31 13:52:42 +08:00
## 功能特性
- [x] 支持 Markdown 所有基础语法
- [x] 支持单独进行字体、字号设置
- [x] 支持色盘取色,并一键替换颜色
- [x] 支持链接微信图文,外链自动转为文末索引
- [x] 支持一键复制并粘贴到公众号后台
- [x] 支持多图上传并将 URL 插入编辑器光标定位处
- [x] 支持一键下载 Markdown 文档到本地
- [x] 支持自定义 CSS 样式并实时渲染
- [x] 支持一键恢复至默认内容及样式
- [x] 支持打开或关闭引用链接的选项
<!--
2019-12-11 20:16:30 +08:00
![select-and-change-color-theme](./assets/images/doocs-md-select-and-change-color-theme.gif)
2019-12-11 20:16:30 +08:00
![copy-and-paste](./assets/images/doocs-md-copy-and-paste.gif)
2019-12-11 20:16:30 +08:00
![custom](./assets/images/doocs-md-custom-css.gif)
![doocs-md-upload-image](./assets/images/doocs-md-upload-image.gif)
-->
![select-and-change-color-theme](https://imgkr.cn-bj.ufileos.com/32c05c23-6309-491f-bd0d-f22a62c944b4.gif)
![copy-and-paste](https://imgkr.cn-bj.ufileos.com/31f16c2f-480c-4ea3-bb89-89b6e14d18e5.gif)
![custom](https://imgkr.cn-bj.ufileos.com/bbf0a0b6-b817-4626-bf79-4e18df318681.gif)
![doocs-md-upload-image](https://imgkr.cn-bj.ufileos.com/97db3cd6-bddc-4eff-8635-472631b0a642.gif)
2020-01-19 14:20:56 +08:00
## 谁在使用
<table>
<tr>
<td align="center" style="width: 160px;">
<a href="https://github.com/doocs">
<img src="https://user-images.githubusercontent.com/21008209/71453045-50269300-27c4-11ea-835d-084439d17d72.png" style="width: 500px;"><br>
<sub>Doocs开源社区</sub>
</a>
</tr>
</table>
注:如果你使用了本 Markdown 编辑器进行文章排版,并且希望在本项目 README 中展示你的公众号,请到 [#5](https://github.com/doocs/md/issues/5) 留言。
## 示例文章
- [ES6 特性快速扫盲](https://mp.weixin.qq.com/s/I3EzOO0skf8xDCGtyYM5Lg)
- [免费且好用的图床,就你了,「图壳」!](https://mp.weixin.qq.com/s/0HhgHLo_tTRFZcC-CVjDbw)
2019-12-10 09:04:52 +08:00
- [GitHub 项目持续本地化,交给它来做,准没错!](https://mp.weixin.qq.com/s/KO4xHr4EI0YfjF0hiT3pbw)
- [阿里又一个 20k+ stars 开源项目诞生,恭喜 fastjson](https://mp.weixin.qq.com/s/RNKDCK2KoyeuMeEs6GUrow)
- [全球最大的成人网站 Pornhub 2019 年度报告新鲜出炉!](https://mp.weixin.qq.com/s/LY5kOzof1h3I0bw7tCkV1Q)
2019-12-10 09:04:52 +08:00
- [刷掉 90 % 候选人的海量数据面试题(附题解+方法总结)](https://mp.weixin.qq.com/s/rjGqxUvrEqJNlo09GrT1Dw)
- [GitHub 标星 11.5k 的一款开源工具,助你轻松查看 Git 历史](https://mp.weixin.qq.com/s/PK-ikENqF13Lmqy2pcMhYQ)
## 项目维护者
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<a href="https://opencollective.com/doocs-md/contributors.svg?width=890&button=true"><img src="https://opencollective.com/doocs-md/contributors.svg?width=890&button=false" /></a>
<!-- ALL-CONTRIBUTORS-LIST:END -->
## 项目许可证
2020-01-31 13:52:42 +08:00
[本项目没有任何限制Just Do What The F*ck You Want。](LICENSE)