docs: refine user guide documentation for Halo 2.1.0 (#159)

为 Halo 2.1 完善用户使用指南。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/157

```release-note
None
```
JohnNiang-patch-1
BugKing 2 years ago committed by GitHub
parent c1bc43a686
commit f89f0beadf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -27,6 +27,10 @@ description: 插件管理相关功能说明
以 Unsplash 插件为例,该提供仅在基本设置组中提供了 `Access Key` 一项配置,用于调用 Unsplash 接口。 以 Unsplash 插件为例,该提供仅在基本设置组中提供了 `Access Key` 一项配置,用于调用 Unsplash 接口。
:::info
你可以点击插件列表指定插件所在行后方的 `···` 更多操作按钮,选择其中的 `重置` 选项将插件提供的设置项恢复为默认值。
:::
## 启用/禁用插件 ## 启用/禁用插件
点击插件列表或插件详情页中的启用/禁用开关,即可切换插件的启用禁用状态。 点击插件列表或插件详情页中的启用/禁用开关,即可切换插件的启用禁用状态。
@ -39,9 +43,10 @@ description: 插件管理相关功能说明
## 卸载插件 ## 卸载插件
点击插件列表指定插件所在行后方的 `···` 更多操作按钮,选择其中的 `卸载` `卸载并删除配置` 选项即可对当前插件进行卸载。 点击插件列表指定插件所在行后方的 `···` 更多操作按钮,选择其中的 `卸载` 选项即可对当前插件进行卸载。
![卸载插件](/img/user-guide/plugins/plugin-uninstall.png) ![卸载插件](/img/user-guide/plugins/plugin-uninstall.png)
:::info :::info
目前提供了 `卸载``卸载并删除配置` 两种卸载方式。
仅卸载插件时插件的配置信息会进行保留,当重新安装插件后还可以使用之前已保存的配置。 仅卸载插件时插件的配置信息会进行保留,当重新安装插件后还可以使用之前已保存的配置。
::: :::

@ -19,7 +19,9 @@ description: 文章管理相关功能说明
在文章编辑器中输入你想展现的内容,你可以通过编辑器上方的工具栏调整指定内容的格式或者插入图片、音视频等各类附件。编辑器还提供了各种快捷指令,通过输入 `/` 字符便可以快速选择常用的输入类型,不需要操作鼠标便可以轻松完成文章排版。 在文章编辑器中输入你想展现的内容,你可以通过编辑器上方的工具栏调整指定内容的格式或者插入图片、音视频等各类附件。编辑器还提供了各种快捷指令,通过输入 `/` 字符便可以快速选择常用的输入类型,不需要操作鼠标便可以轻松完成文章排版。
:::info :::info
编辑器详细使用说明请参考[《用户指南-编辑器》](./posts.md) 编辑器详细使用说明请参考[《用户指南-编辑器》](./posts.md)。
如果安装并启用了额外的编辑器插件,可以点击右上角切换使用不同的编辑器。以下文档内容均使用默认编辑器进行说明。
::: :::
在页面右侧你可以看到文章的大纲结构及字词数等详细信息。一切满意之后,你可以选择暂存这篇文章的草稿或直接将文章进行发布。 在页面右侧你可以看到文章的大纲结构及字词数等详细信息。一切满意之后,你可以选择暂存这篇文章的草稿或直接将文章进行发布。
@ -55,7 +57,8 @@ description: 文章管理相关功能说明
- **私有**:仅文章作者可以看到这篇文章。 - **私有**:仅文章作者可以看到这篇文章。
- **发表时间**:手动指定文章的发表时间,未指定时以实际发布时间为准; - **发表时间**:手动指定文章的发表时间,未指定时以实际发布时间为准;
- **自定义模板**:主题端使用哪一个文章模板进行页面渲染; - **自定义模板**:主题端使用哪一个文章模板进行页面渲染;
- **封面图**:用户在主题端显示的文章封面图,需要主题支持该功能。 - **封面图**:用户在主题端显示的文章封面图,需要主题支持该功能;
- **元数据**:供主题、插件使用的额外数据信息。例如 Halo 官网主题仓库中的主题,便可以使用该功能为主题类型的文章增加一条名为下载地址的元数据,提供对应主题的下载链接。
## 发布及取消发布 ## 发布及取消发布
@ -96,7 +99,8 @@ description: 文章管理相关功能说明
- **别名**:用于分类 URL 路径定位。默认路径规则为 `$HALO_EXTERNAL_URL/categories/{slug}`,其中 `slug` 为分类别名,访问该地址即可浏览该分类下的所有文章。分类页路由前缀可[在设置中修改](./settings#主题路由设置) - **别名**:用于分类 URL 路径定位。默认路径规则为 `$HALO_EXTERNAL_URL/categories/{slug}`,其中 `slug` 为分类别名,访问该地址即可浏览该分类下的所有文章。分类页路由前缀可[在设置中修改](./settings#主题路由设置)
- **自定义模板**:主题端使用哪一个文章分类模板进行页面渲染; - **自定义模板**:主题端使用哪一个文章分类模板进行页面渲染;
- **封面图**:用户在主题端显示的文章分类封面图,需要主题支持该功能; - **封面图**:用户在主题端显示的文章分类封面图,需要主题支持该功能;
- **描述**:关于改文章分类的更多描述信息。 - **描述**:关于改文章分类的更多描述信息;
- **元数据**:供主题、插件使用的额外数据信息。例如部分主题期望使用不同的颜色对分类进行区分,便可以使用该功能为分类增加颜色相关的元数据。
### 调整分类层级 ### 调整分类层级
@ -129,6 +133,7 @@ description: 文章管理相关功能说明
- **别名**:用于标签 URL 路径定位。默认路径规则为 `$HALO_EXTERNAL_URL/tags/{slug}`,其中 `slug` 为标签别名,访问该地址即可浏览具有该标签的所有文章。标签页路由前缀可[在设置中修改](./settings#主题路由设置) - **别名**:用于标签 URL 路径定位。默认路径规则为 `$HALO_EXTERNAL_URL/tags/{slug}`,其中 `slug` 为标签别名,访问该地址即可浏览具有该标签的所有文章。标签页路由前缀可[在设置中修改](./settings#主题路由设置)
- **颜色**:用于在控制台及主题端显示的标签颜色,主题端显示颜色需要主题支持该功能; - **颜色**:用于在控制台及主题端显示的标签颜色,主题端显示颜色需要主题支持该功能;
- **封面图**:用户在主题端显示的标签封面图,需要主题支持该功能; - **封面图**:用户在主题端显示的标签封面图,需要主题支持该功能;
- **元数据**:供主题、插件使用的额外数据信息。
### 修改删除标签 ### 修改删除标签

@ -10,7 +10,7 @@ description: 主题管理相关功能说明
## 安装主题 ## 安装主题
点击主题页面右上方的 `切换主题` 按钮即可弹出主题管理对话框。 点击主题页面右上方的 `主题管理` 按钮即可弹出主题管理对话框。
目前 Halo 提供了两种主题安装方式: 目前 Halo 提供了两种主题安装方式:
@ -31,13 +31,15 @@ description: 主题管理相关功能说明
## 切换主题 ## 切换主题
同样点击主题页面右上方的 `切换主题` 按钮弹出主题管理对话框。 同样点击主题页面右上方的 `主题管理` 按钮弹出主题管理对话框。
在弹框中点击选中要切换的目标主题,此时页面返回到主题详情页,点击右上角的 `启用` 按钮即可将当前主题切换为实际使用的主题。 在弹框中点击选中要切换的目标主题,此时页面返回到主题详情页,点击右上角的 `启用` 按钮即可将当前主题切换为实际使用的主题。
:::info :::info
切换主题不点击右上角的 `启用` 按钮时,不会影响当前实际使用的主题。 选中主题不点击右上角的 `启用` 按钮时,不会影响当前实际使用的主题。
::: :::
你也可以在已安装主题列表中,通过后方 ··· 的更多操作中的启用选项直接启用指定的主题。
## 修改主题设置 ## 修改主题设置
主题页面默认显示出了当前主题的详细信息,在详细信息标签页后方的标签页,即为主题提供的相关设置。不同的主题提供的设置项各不相同,设置项的详细说明请参考对应主题的文档。 主题页面默认显示出了当前主题的详细信息,在详细信息标签页后方的标签页,即为主题提供的相关设置。不同的主题提供的设置项各不相同,设置项的详细说明请参考对应主题的文档。
@ -46,6 +48,10 @@ description: 主题管理相关功能说明
以 Halo 的默认主题 Earth 为例,该主题提供了布局、样式、侧边栏、页脚及备案设置共五组配置项。 以 Halo 的默认主题 Earth 为例,该主题提供了布局、样式、侧边栏、页脚及备案设置共五组配置项。
:::info
你可以点击主题列表指定主题所在行后方的 `···` 更多操作按钮,选择其中的 `重置` 选项将主题提供的设置项恢复为默认值。
:::
## 预览主题 ## 预览主题
通过预览功能,你可以在不更改当前启用主题的情况下查看不同主题的效果。点击主题详情页面右上角的 `预览` 按钮预览当前主题,或者进入已安装主题列表,通过后方 `···` 的更多操作中的预览选项预览指定的主题。 通过预览功能,你可以在不更改当前启用主题的情况下查看不同主题的效果。点击主题详情页面右上角的 `预览` 按钮预览当前主题,或者进入已安装主题列表,通过后方 `···` 的更多操作中的预览选项预览指定的主题。
@ -54,15 +60,21 @@ description: 主题管理相关功能说明
在主题预览页面你可以切换不同分辨率的设备,模拟主题在不同终端下的显示效果。也可以通过右上角的功能菜单切换预览的主题,或者调整当前主题的设置,查看不同设置下主题所展现的区别。 在主题预览页面你可以切换不同分辨率的设备,模拟主题在不同终端下的显示效果。也可以通过右上角的功能菜单切换预览的主题,或者调整当前主题的设置,查看不同设置下主题所展现的区别。
## 更新主题 ## 升级主题
点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `更新` 选项即可上传新的主题包对当前主题进行更新。 点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `升级` 选项即可上传新的主题包对当前主题进行升级更新。
## 重载主题配置 ## 重载主题配置
如果当前主题提供的设置象发生变化,可以通过 `···` 更多中的 `重载主题配置` 选项对主体配置项进行更新。 如果当前主题提供的设置项发生变化,可以通过 `···` 更多操作中的 `重载主题配置` 选项对主题配置项进行更新。
## 卸载主题 ## 卸载主题
进入已安装主题列表,通过后方 `···` 的更多操作中的卸载选项即可卸载指定的主题。 进入已安装主题列表,点击指定主题所在行后方的 `···` 更多操作按钮,选择其中的 `卸载` 选项即可对当前主题进行卸载。
![卸载主题](/img/user-guide/themes/theme-uninstall.png) ![卸载主题](/img/user-guide/themes/theme-uninstall.png)
:::info
目前提供了 `卸载``卸载并删除配置` 两种卸载方式。
仅卸载主题时主题的配置信息会进行保留,当重新安装主题后还可以使用之前已保存的配置。
:::

@ -30,6 +30,7 @@ Halo 中的权限控制体系示例:
- **手机号** - **手机号**
- **头像** - **头像**
- **描述** - **描述**
- **元数据**:供主题、插件使用的额外数据信息。例如部分主题期望展示作者的学历、工作单位等信息,便可以使用该功能为用户增加相关的元数据。
### 其他操作 ### 其他操作

Binary file not shown.

Before

Width:  |  Height:  |  Size: 172 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 165 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 153 KiB

Loading…
Cancel
Save