mirror of
https://github.com/doocs/md.git
synced 2024-11-24 19:10:34 +08:00
chore: resolve switch problem and update doc (#110)
This commit is contained in:
Yang Libin
GitHub
parent
56d8fb66e7
commit
050621ad71
106
README.md
106
README.md
@ -32,51 +32,6 @@ Markdown 文档自动即时渲染为微信图文，让你不再为微信文章
|
||||
|
||||
欢迎各位朋友随时提交 PR，让这款微信 Markdown 编辑器变得更好！如果你有新的想法，也欢迎在 [Discussions 讨论区](https://github.com/doocs/md/discussions)反馈。
|
||||
|
||||
## 快速搭建私有服务
|
||||
|
||||
通过我们的 npm cli 你可以轻易搭建属于自己的 markdown 微信编辑器。
|
||||
|
||||
```sh
|
||||
# 安装
|
||||
npm i -g @doocs/md-cli
|
||||
|
||||
# 启动
|
||||
md-cli
|
||||
|
||||
# 访问
|
||||
open http://127.0.0.1:8800/md/
|
||||
```
|
||||
|
||||
支持命令行参数:
|
||||
|
||||
- `port` 指定端口号，默认 8800，如果被占用会随机使用一个新端口。
|
||||
- `spaceId` dcloud 服务空间配置
|
||||
- `clientSecret` dcloud 服务空间配置
|
||||
|
||||
参数示例：
|
||||
|
||||
```sh
|
||||
md-cli port=8899
|
||||
```
|
||||
|
||||
## 如何开发和部署
|
||||
|
||||
```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/
|
||||
```
|
||||
|
||||
## 功能特性
|
||||
|
||||
- [x] 支持自定义 CSS 样式
|
||||
@ -98,7 +53,7 @@ npm run build:h5-netlify
|
||||
| 4 | [阿里云](https://www.aliyun.com/product/oss) | 配置 `AccessKey ID`、`AccessKey Secret`、`Bucket`、`Region` 参数 | [如何使用阿里云 OSS？](https://help.aliyun.com/document_detail/31883.html) |
|
||||
| 5 | [腾讯云](https://cloud.tencent.com/act/pro/cos) | 配置 `SecretId`、`SecretKey`、`Bucket`、`Region` 参数 | [如何使用腾讯云 COS？](https://cloud.tencent.com/document/product/436/38484) |
|
||||
| 6 | [七牛云](https://www.qiniu.com/products/kodo) | 配置 `AccessKey`、`SecretKey`、`Bucket`、`Domain`、`Region` 参数 | [如何使用七牛云 Kodo？](https://developer.qiniu.com/kodo) |
|
||||
| - | 自定义上传逻辑 | 是 | 参考[自定义上传逻辑参数详情](#自定义上传逻辑) |
|
||||
| - | 自定义上传逻辑 | 是 | [参考自定义上传逻辑](#自定义上传逻辑) |
|
||||
|
||||
|
||||
|
||||
@ -108,13 +63,17 @@ npm run build:h5-netlify
|
||||
|
||||
|
||||
|
||||
## 注意事项
|
||||
|
||||
如果你使用了某些浏览器脚本修改了网页背景色，可能导致渲染后的文章出现背景色分块的现象，详见 [#63](https://github.com/doocs/md/issues/63)。
|
||||
|
||||
## 自定义上传逻辑
|
||||
|
||||
在工具上没有提供预定义图床的情况下，你只需要自定义上传逻辑即可，这对于例如你不方便使用公共图床，而是使用自己的上传服务时非常有用。
|
||||
|
||||
你只需要在给定的函数中更改上传代码即可，为了方便，这个函数提供了可能使用的一些参数：
|
||||
|
||||
示例代码:
|
||||
示例代码：
|
||||
|
||||
```js
|
||||
const { file, util, okCb, errCb } = CUSTOM_ARG;
|
||||
@ -147,16 +106,57 @@ util.axios
|
||||
// getDir, // 获取 年/月/日 形式的目录
|
||||
// getDateFilename, // 根据文件名获取它以 时间戳+uuid 的形式
|
||||
// },
|
||||
// okCb: resolve, // 重要: 上传成功后给此回调传 url 即可
|
||||
// okCb: resolve, // 重要！上传成功后给此回调传 url 即可
|
||||
// errCb: reject, // 上传失败调用的函数
|
||||
// }
|
||||
```
|
||||
|
||||
如果你创建了适用于其他第三方图床的上传代码，我们非常欢迎你分享它。
|
||||
|
||||
## 注意事项
|
||||
## 如何开发和部署
|
||||
|
||||
如果你使用了某些浏览器脚本修改了网页背景色，可能导致渲染后的文章出现背景色分块的现象，详见 [#63](https://github.com/doocs/md/issues/63)。
|
||||
```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/
|
||||
```
|
||||
|
||||
## 快速搭建私有服务
|
||||
|
||||
通过我们的 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 服务空间配置
|
||||
|
||||
## 谁在使用
|
||||
|
||||
@ -329,12 +329,6 @@ util.axios
|
||||
|
||||
注：如果你使用了本 Markdown 编辑器进行文章排版，并且希望在本项目 README 中展示你的公众号，请到 [#5](https://github.com/doocs/md/discussions/5) 留言。
|
||||
|
||||
## 项目许可证
|
||||
|
||||
[本项目没有任何限制，Just Do What The F\*ck You Want。](LICENSE)
|
||||
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdoocs%2Fmd?ref=badge_large)
|
||||
|
||||
---
|
||||
|
||||
## Doocs 社区优质项目
|
||||
|
||||
@ -230,6 +230,7 @@ export default {
|
||||
currentColor: (state) => state.currentColor,
|
||||
codeTheme: (state) => state.codeTheme,
|
||||
nightMode: (state) => state.nightMode,
|
||||
currentCiteStatus: (state) => state.citeStatus,
|
||||
}),
|
||||
},
|
||||
methods: {
|
||||
@ -351,6 +352,7 @@ export default {
|
||||
this.selectSize = this.currentSize;
|
||||
this.selectColor = this.currentColor;
|
||||
this.selectCodeTheme = this.codeTheme;
|
||||
this.citeStatus = this.currentCiteStatus;
|
||||
},
|
||||
};
|
||||
</script>
|
||||
|
||||
@ -76,7 +76,6 @@ const mutations = {
|
||||
theme: setColor(state.currentColor),
|
||||
fonts: state.currentFont,
|
||||
size: state.currentSize,
|
||||
status: state.citeStatus,
|
||||
});
|
||||
},
|
||||
initEditorEntity(state) {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user