Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Mereithhh committed Sep 6, 2022
1 parent 9c592a1 commit 470f54d
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 8 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,15 @@
<img alt="打赏-支付宝" src="/img/ali-pay.jpg" style="width: 200px" />
</p>

## 捐赠信息

PS:如果打赏时请备注捐赠者,如有遗漏请联系我添加(有时候消息多可能会漏掉,十分抱歉)

| 捐赠者 | 捐赠金额 | 捐赠日期 |
| --- | --- | --- |
| Sirit | 6.66 元 | 2022-09-01 |
| jingcheng | 100 元 | 2022-09-06 |

## Star 趋势图

[![Star History Chart](https://api.star-history.com/svg?repos=mereithhh/van-blog&type=Date)](https://star-history.com/#mereithhh/van-blog&Date)
6 changes: 6 additions & 0 deletions docs/feature/advance/collaborator.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,9 @@ title: 协作者
除了拥有 `所有权限` 的协作者外,登录后都将看到精简的 UI:

![](https://www.mereith.com/static/img/bbb3252731394960a7b307248a28a107.clipboard-2022-09-03.png)

### 作者问题

在创建文章或草稿时,默认的作者登录者本人的昵称(如果是管理员则是站点管理中设置的作者名称)。

此作者也会显示在前端的版权声明中。
6 changes: 4 additions & 2 deletions docs/feature/basic/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ shortTitle: 文章管理

具体有以下选项:

![](https://pic.mereith.com/img/586d268137547ea2bfe259fd356735f6.clipboard-2022-08-15.png)

![](https://www.mereith.com/static/img/eb61858881bc9651694f8bc5d45c9387.clipboard-2022-09-06.png)
## 导入 markdown

你可以点击 `导入` 按钮导入 `markdown` 文件来创建文章,暂不支持其他类型的文件。
Expand Down Expand Up @@ -48,6 +47,9 @@ shortTitle: 文章管理
### 文章标题

这个没啥好说的,没有特殊要求
### 作者

默认为登录者本人,下拉框内的选择范围包括`所有的协作者的昵称`以及后台站点设置中的`作者名称`

### 顶置优先级

Expand Down
8 changes: 6 additions & 2 deletions docs/feature/basic/draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ title: 草稿管理

具体有以下选项:

![](https://pic.mereith.com/img/00809c704c83e67c946b73e951306fd7.clipboard-2022-08-16.png)
![](https://www.mereith.com/static/img/4f96f5e2e1d7d289e85f69cabe2a8d35.clipboard-2022-09-06.png)

### 作者

默认为登录者本人,下拉框内的选择范围包括`所有的协作者的昵称`以及后台站点设置中的`作者名称`

## 导入 markdown

Expand Down Expand Up @@ -98,4 +102,4 @@ title: 草稿管理

当编辑时,会自动实时保存内容到本地缓存,如果没有点击保存按钮就退出了编辑器,下次进入后会自动回复上次的状态。

![](https://pic.mereith.com/img/85fa1dc72226c92b7b176cc40690999d.clipboard-2022-08-31.png)
![](https://pic.mereith.com/img/85fa1dc72226c92b7b176cc40690999d.clipboard-2022-08-31.png)
16 changes: 13 additions & 3 deletions docs/feature/basic/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: 编辑器
:::
`vanBlog` 后台内置了 [bytemd](https://github.com/bytedance/bytemd)(掘金同款) 作为 `markdown` 编辑器:

![](https://pic.mereith.com/img/577da489715c94c183247ba63887aac5.clipboard-2022-08-30.png)
![](https://www.mereith.com/static/img/e0ce4ddda865c9b7827983a219468599.clipboard-2022-09-06.png)

支持数学公式和图表、支持一键上传剪切板图片到图床、一键插入 `more` 标记、快捷键、自动保存等功能。

Expand Down Expand Up @@ -49,13 +49,13 @@ title: 编辑器

点击右上角操作按钮,选择 `导出`,即可导出为 `markdown` 文件,相关数据会自动放置到 `front-matter` 中。

![](https://pic.mereith.com/img/4218768fe6d1c8d69433bde3fd98c01b.clipboard-2022-08-30.png)
![](https://www.mereith.com/static/img/52495adf0928d2034159a398cbc7e050.clipboard-2022-09-06.png)

## 修改信息

点击右上角操作按钮,选择 `修改信息`,即可对当前编辑的 `文章/草稿` 的信息就行修改。

![](https://pic.mereith.com/img/4218768fe6d1c8d69433bde3fd98c01b.clipboard-2022-08-30.png)
![](https://www.mereith.com/static/img/52495adf0928d2034159a398cbc7e050.clipboard-2022-09-06.png)

## 语法速查、快捷键与帮助

Expand All @@ -68,3 +68,13 @@ title: 编辑器
> 图表语法速查 [Mermaid 从入门到入土——Markdown 进阶语法](https://zhuanlan.zhihu.com/p/355997933)
>
> 数学公式语法速查 [使用 Markdown 输出 LaTex 数学公式](https://zhuanlan.zhihu.com/p/59412540)
## 偏好设置

编辑器现在支持偏好设置,未来将支持更多选项:

![](https://www.mereith.com/static/img/52495adf0928d2034159a398cbc7e050.clipboard-2022-09-06.png)

![](https://www.mereith.com/static/img/031c5d647a21e1f57efbceb615661486.clipboard-2022-09-06.png)

PS:此设置保存在浏览器的 `LocalStorage` 中,切换设备需重新设置。
10 changes: 9 additions & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持 HTTPS
- [ ] 增加一些 e2e 测试,集成到 CI
- [ ] 国际化


## 打赏

如果你觉得本项目还不错,可以打赏哦。您的支持就是我最大的动力!
Expand All @@ -115,6 +114,15 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持 HTTPS
<img alt="打赏-支付宝" src="./assets/ali-pay.jpg" style="width: 200px" />
</p>

## 捐赠信息

PS:如果打赏时请备注捐赠者,如有遗漏请联系我添加(有时候消息多可能会漏掉,十分抱歉)

| 捐赠者 | 捐赠金额 | 捐赠日期 |
| --------- | -------- | ---------- |
| Sirit | 6.66 元 | 2022-09-01 |
| jingcheng | 100 元 | 2022-09-06 |

## 预览图

![前台-白色](./assets/前台-白色.png)
Expand Down

0 comments on commit 470f54d

Please sign in to comment.