docs: add documentations for app store plugin (#365)

添加内置应用市场的使用说明,以及更新插件和主题的安装文档。

/kind documentation

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

```release-note
None
```
wan92hen-patch-1
Ryan Wang 6 months ago committed by GitHub
parent 07e7417c83
commit 78416a1337
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1,70 @@
---
title: 应用市场
description: 内置应用市场的使用说明
---
为了方便使用者安装应用市场的主题和插件,我们提供了一个内置到 Console 的应用市场插件,可以更加方便在 Console 直接安装主题和插件。并且此插件从 Halo 2.10 开始已经预设到 Halo 中,无需手动安装。
如果你使用了旧版本的 Halo并且当前未安装应用市场插件可以访问 <https://www.halo.run/store/apps/app-VYJbF> 手动下载并在 Console 的插件管理中安装。
:::info 提示
这是目前唯一由 Halo 官方提供的服务,如果你当前的 Halo 网站处于无法访问外网的环境或者不需要此功能,你可以卸载或者停用此插件,不会影响网站的正常使用。
:::
## 应用市场页面
这是一个为 Console 提供的独立的应用市场页面,此页面基本和 <https://www.halo.run/store/apps> 保持一致,但有所不同的是,你可以直接在这里查看所有的主题和插件并安装到你的 Halo 站点中。
![应用市场](/img/user-guide/app-store/app-store-page.png)
## 绑定 Halo 官网账号
![账号绑定](/img/user-guide/app-store/app-store-pat.png)
如果你需要购买 Halo 应用市场中的付费应用,建议先绑定好 Halo 官网的账号,绑定之后即可直接在 Console 中购买和安装付费应用和主题。
绑定方式:
1. 进入应用市场插件的设置页面,切换到 **账号绑定** 选项卡。
2. 根据提示访问 Halo 官网并注册账号,然后在 Halo 官网的[个人中心](https://www.halo.run/uc/profile?tab=pat)生成一个个人令牌并填写到下方的 **个人令牌** 输入框即可。
## 安装/更新插件
此插件还扩展了插件安装的界面,可以在安装插件时直接从应用市场获取。
![安装插件](/img/user-guide/app-store/app-store-plugins.png)
此外,如果插件是从应用市场安装的,后续插件更新之后也可以及时收到更新信息,并一键更新。
![更新插件](/img/user-guide/app-store/app-store-upgrade-plugin.png)
## 安装/更新主题
与插件一样,在主题管理中也可以直接从应用市场中获取,以及接受主题更新提示。
![安装主题](/img/user-guide/app-store/app-store-themes.png)
![更新主题](/img/user-guide/app-store/app-store-upgrade-theme.png)
## 付费应用激活
目前部分付费主题和插件需要许可证激活才能够正常使用,在购买付费应用之后就会自动为你的 Halo 官网账号中生成对应的应用许可证,**所以在此之前需要确保已经在你的网站中绑定好了 Halo 官网账号**。
:::info 注意
当前应用市场的许可证暂不支持离线激活,需要 Halo 所在的服务器能够正常访问 <https://www.halo.run>
:::
在安装好需要许可证的付费插件或主题后,列表会显示一个许可证状态的图标,点击即可打开许可证激活的对话框,选择许可证并点击激活即可。
![插件激活状态](/img/user-guide/app-store/app-store-license-status.png)
![插件许可证激活](/img/user-guide/app-store/app-store-plugin-license.png)
除此之外,你也可以在 **许可证管理** 页面查看所有应用的许可证,并管理它们的状态。
![许可证列表](/img/user-guide/app-store/app-store-license-manage.png)
其他注意事项:
1. 目前同一个账号的许可证在同一时间只能在一个站点中使用,使用 Halo 配置中的 **外部访问地址halo.external-url** 和设备 id 做判定。
2. 取消激活会删除许可证使用记录。

@ -10,15 +10,24 @@ description: 插件管理相关功能说明
:::info
目前有两个官方渠道可以获取插件:
- 应用市场:<https://halo.run/store/apps>
- 应用市场:<https://www.halo.run/store/apps>
- Awesome Halo<https://github.com/halo-sigs/awesome-halo>
:::
## 安装插件
进入插件管理页面,点击右上角的 `安装` 按钮即可打开插件安装的对话框。
和主题一样,插件同时支持本地上传安装和远程下载安装。
### 从内置应用市场安装(推荐)
从 Halo 2.10 开始,内置了应用市场插件,可以更加方便在 Console 直接安装应用市场的插件。
![安装插件](/img/user-guide/app-store/app-store-plugins.png)
:::info
更多关于内置应用市场的使用说明可查阅:[应用市场](./app-store.md)
:::
### 本地上传安装
@ -26,19 +35,16 @@ description: 插件管理相关功能说明
插件安装成功后,便会出现在插件管理的列表中。
:::info 注意
从非 Halo 官网应用市场安装插件时,请务必注意其安全性。
:::
### 远程下载安装
同样,在安装插件的对话框中,切换到远程下载选项卡,输入插件的下载地址,点击 `下载` 按钮即可开始下载插件。
插件安装成功后,便会出现在插件管理的列表中。
此外, Halo 的[应用市场](https://halo.run/store/apps)也支持通过输入站点地址的方式自动跳转到你的站点进行安装,演示视频:
<!-- markdownlint-disable MD034 -->
<video src="https://assets.halo.run/install-plugin-from-store.mp4" controls style={{width: '100%', borderRadius: '8px'}}/>
:::info
插件安装成功后会提示你是否需要启动该插件,你可以根据需要选择是否启动。
:::info 注意
从非 Halo 官网应用市场安装插件时,请务必注意其安全性。
:::
## 插件设置
@ -61,7 +67,9 @@ description: 插件管理相关功能说明
## 升级插件
点击具体插件的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级插件的对话框,与安装插件一样,同时支持本地上传和远程下载。
如果当前使用了内置的应用市场插件,在插件更新后会在插件列表中显示更新提示,点击 **立即更新** 按钮即可。
手动升级可以点击具体插件的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级插件的对话框。
## 重置

@ -8,15 +8,24 @@ description: 主题管理相关功能说明
:::info
目前有两个官方渠道可以获取主题:
- 应用市场:<https://halo.run/store/apps>
- 应用市场:<https://www.halo.run/store/apps>
- Awesome Halo<https://github.com/halo-sigs/awesome-halo>
:::
## 安装主题
点击主题页面右上方的 `主题管理` 按钮即可弹出主题管理对话框。
目前 Halo 提供了两种主题安装方式。
### 从内置应用市场安装(推荐)
从 Halo 2.10 开始,内置了应用市场插件,可以更加方便在 Console 直接安装应用市场的主题。
![安装主题](/img/user-guide/app-store/app-store-themes.png)
:::info
更多关于内置应用市场的使用说明可查阅:[应用市场](./app-store.md)
:::
### 本地上传安装
@ -24,19 +33,10 @@ description: 主题管理相关功能说明
![安装主题](/img/user-guide/themes/theme-install.png)
主题安装成功后,便会出现在已安装主题列表中。
### 远程下载安装
同样,在安装主题的对话框中,切换到远程下载选项卡,输入主题的下载地址,点击 `下载` 按钮即可开始下载主题。
下载完成后,便会出现在已安装主题列表中。
此外, Halo 的[应用市场](https://halo.run/store/apps)也支持通过输入站点地址的方式自动跳转到你的站点进行安装,演示视频:
<!-- markdownlint-disable MD034 -->
<video src="https://assets.halo.run/install-theme-from-store.mp4" controls style={{width: '100%', borderRadius: '8px'}}/>
## 切换主题
同样点击主题页面右上方的 `主题管理` 按钮弹出主题管理对话框。
@ -74,7 +74,9 @@ description: 主题管理相关功能说明
## 升级主题
点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级主题的对话框,与安装主题一样,同时支持本地上传和远程下载。
如果当前使用了内置的应用市场插件,在主题更新后会在主题列表中显示更新提示,点击 **立即更新** 按钮即可。
手动升级可以点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级主题的对话框。
## 重载主题配置

@ -81,6 +81,7 @@ module.exports = {
"user-guide/attachments",
"user-guide/themes",
"user-guide/plugins",
"user-guide/app-store",
"user-guide/users",
"user-guide/settings",
"user-guide/backup",

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 491 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 388 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 357 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

@ -0,0 +1,70 @@
---
title: 应用市场
description: 内置应用市场的使用说明
---
为了方便使用者安装应用市场的主题和插件,我们提供了一个内置到 Console 的应用市场插件,可以更加方便在 Console 直接安装主题和插件。并且此插件从 Halo 2.10 开始已经预设到 Halo 中,无需手动安装。
如果你使用了旧版本的 Halo并且当前未安装应用市场插件可以访问 <https://www.halo.run/store/apps/app-VYJbF> 手动下载并在 Console 的插件管理中安装。
:::info 提示
这是目前唯一由 Halo 官方提供的服务,如果你当前的 Halo 网站处于无法访问外网的环境或者不需要此功能,你可以卸载或者停用此插件,不会影响网站的正常使用。
:::
## 应用市场页面
这是一个为 Console 提供的独立的应用市场页面,此页面基本和 <https://www.halo.run/store/apps> 保持一致,但有所不同的是,你可以直接在这里查看所有的主题和插件并安装到你的 Halo 站点中。
![应用市场](/img/user-guide/app-store/app-store-page.png)
## 绑定 Halo 官网账号
![账号绑定](/img/user-guide/app-store/app-store-pat.png)
如果你需要购买 Halo 应用市场中的付费应用,建议先绑定好 Halo 官网的账号,绑定之后即可直接在 Console 中购买和安装付费应用和主题。
绑定方式:
1. 进入应用市场插件的设置页面,切换到 **账号绑定** 选项卡。
2. 根据提示访问 Halo 官网并注册账号,然后在 Halo 官网的[个人中心](https://www.halo.run/uc/profile?tab=pat)生成一个个人令牌并填写到下方的 **个人令牌** 输入框即可。
## 安装/更新插件
此插件还扩展了插件安装的界面,可以在安装插件时直接从应用市场获取。
![安装插件](/img/user-guide/app-store/app-store-plugins.png)
此外,如果插件是从应用市场安装的,后续插件更新之后也可以及时收到更新信息,并一键更新。
![更新插件](/img/user-guide/app-store/app-store-upgrade-plugin.png)
## 安装/更新主题
与插件一样,在主题管理中也可以直接从应用市场中获取,以及接受主题更新提示。
![安装主题](/img/user-guide/app-store/app-store-themes.png)
![更新主题](/img/user-guide/app-store/app-store-upgrade-theme.png)
## 付费应用激活
目前部分付费主题和插件需要许可证激活才能够正常使用,在购买付费应用之后就会自动为你的 Halo 官网账号中生成对应的应用许可证,**所以在此之前需要确保已经在你的网站中绑定好了 Halo 官网账号**。
:::info 注意
当前应用市场的许可证暂不支持离线激活,需要 Halo 所在的服务器能够正常访问 <https://www.halo.run>
:::
在安装好需要许可证的付费插件或主题后,列表会显示一个许可证状态的图标,点击即可打开许可证激活的对话框,选择许可证并点击激活即可。
![插件激活状态](/img/user-guide/app-store/app-store-license-status.png)
![插件许可证激活](/img/user-guide/app-store/app-store-plugin-license.png)
除此之外,你也可以在 **许可证管理** 页面查看所有应用的许可证,并管理它们的状态。
![许可证列表](/img/user-guide/app-store/app-store-license-manage.png)
其他注意事项:
1. 目前同一个账号的许可证在同一时间只能在一个站点中使用,使用 Halo 配置中的 **外部访问地址halo.external-url** 和设备 id 做判定。
2. 取消激活会删除许可证使用记录。

@ -10,15 +10,24 @@ description: 插件管理相关功能说明
:::info
目前有两个官方渠道可以获取插件:
- 应用市场:<https://halo.run/store/apps>
- 应用市场:<https://www.halo.run/store/apps>
- Awesome Halo<https://github.com/halo-sigs/awesome-halo>
:::
## 安装插件
进入插件管理页面,点击右上角的 `安装` 按钮即可打开插件安装的对话框。
和主题一样,插件同时支持本地上传安装和远程下载安装。
### 从内置应用市场安装(推荐)
从 Halo 2.10 开始,内置了应用市场插件,可以更加方便在 Console 直接安装应用市场的插件。
![安装插件](/img/user-guide/app-store/app-store-plugins.png)
:::info
更多关于内置应用市场的使用说明可查阅:[应用市场](./app-store.md)
:::
### 本地上传安装
@ -26,19 +35,16 @@ description: 插件管理相关功能说明
插件安装成功后,便会出现在插件管理的列表中。
:::info 注意
从非 Halo 官网应用市场安装插件时,请务必注意其安全性。
:::
### 远程下载安装
同样,在安装插件的对话框中,切换到远程下载选项卡,输入插件的下载地址,点击 `下载` 按钮即可开始下载插件。
插件安装成功后,便会出现在插件管理的列表中。
此外, Halo 的[应用市场](https://halo.run/store/apps)也支持通过输入站点地址的方式自动跳转到你的站点进行安装,演示视频:
<!-- markdownlint-disable MD034 -->
<video src="https://assets.halo.run/install-plugin-from-store.mp4" controls style={{width: '100%', borderRadius: '8px'}}/>
:::info
插件安装成功后会提示你是否需要启动该插件,你可以根据需要选择是否启动。
:::info 注意
从非 Halo 官网应用市场安装插件时,请务必注意其安全性。
:::
## 插件设置
@ -61,7 +67,9 @@ description: 插件管理相关功能说明
## 升级插件
点击具体插件的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级插件的对话框,与安装插件一样,同时支持本地上传和远程下载。
如果当前使用了内置的应用市场插件,在插件更新后会在插件列表中显示更新提示,点击 **立即更新** 按钮即可。
手动升级可以点击具体插件的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级插件的对话框。
## 重置

@ -8,15 +8,24 @@ description: 主题管理相关功能说明
:::info
目前有两个官方渠道可以获取主题:
- 应用市场:<https://halo.run/store/apps>
- 应用市场:<https://www.halo.run/store/apps>
- Awesome Halo<https://github.com/halo-sigs/awesome-halo>
:::
## 安装主题
点击主题页面右上方的 `主题管理` 按钮即可弹出主题管理对话框。
目前 Halo 提供了两种主题安装方式。
### 从内置应用市场安装(推荐)
从 Halo 2.10 开始,内置了应用市场插件,可以更加方便在 Console 直接安装应用市场的主题。
![安装主题](/img/user-guide/app-store/app-store-themes.png)
:::info
更多关于内置应用市场的使用说明可查阅:[应用市场](./app-store.md)
:::
### 本地上传安装
@ -24,19 +33,10 @@ description: 主题管理相关功能说明
![安装主题](/img/user-guide/themes/theme-install.png)
主题安装成功后,便会出现在已安装主题列表中。
### 远程下载安装
同样,在安装主题的对话框中,切换到远程下载选项卡,输入主题的下载地址,点击 `下载` 按钮即可开始下载主题。
下载完成后,便会出现在已安装主题列表中。
此外, Halo 的[应用市场](https://halo.run/store/apps)也支持通过输入站点地址的方式自动跳转到你的站点进行安装,演示视频:
<!-- markdownlint-disable MD034 -->
<video src="https://assets.halo.run/install-theme-from-store.mp4" controls style={{width: '100%', borderRadius: '8px'}}/>
## 切换主题
同样点击主题页面右上方的 `主题管理` 按钮弹出主题管理对话框。
@ -74,7 +74,9 @@ description: 主题管理相关功能说明
## 升级主题
点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级主题的对话框,与安装主题一样,同时支持本地上传和远程下载。
如果当前使用了内置的应用市场插件,在主题更新后会在主题列表中显示更新提示,点击 **立即更新** 按钮即可。
手动升级可以点击主题详情页右上角的 `···` 更多操作按钮,选择其中的 `升级` 选项即可打开升级主题的对话框。
## 重载主题配置

@ -65,6 +65,7 @@
"user-guide/attachments",
"user-guide/themes",
"user-guide/plugins",
"user-guide/app-store",
"user-guide/users",
"user-guide/settings",
"user-guide/backup",

Loading…
Cancel
Save