Skip to content

Commit

Permalink
docs: update usage documentation of readme file (#11)
Browse files Browse the repository at this point in the history
更新 README,将使用方式的说明优先级提高并完善。

/kind documentation

```release-note
None 
```
  • Loading branch information
ruibaby committed Jul 7, 2023
1 parent 02dbc81 commit 473f70d
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Expand Up @@ -2,6 +2,15 @@

此插件是对 [halo-sigs/search-widget](https://github.com/halo-sigs/search-widget) 的一个封装,安装之后即可通过调用 JS API 的形式唤起搜索框。

## 使用方式

1. 下载,目前提供以下两个下载方式:
- GitHub Releases:访问 [Releases](https://github.com/halo-sigs/plugin-search-widget/releases) 下载 Assets 中的 JAR 文件。
- Halo 应用市场:<https://halo.run/store/apps/app-DlacW>
2. 安装,插件安装和更新方式可参考:<https://docs.halo.run/user-guide/plugins>

> 需要注意的是,此插件需要主题进行适配,不会主动显示搜索入口。
## 开发环境

```bash
Expand Down Expand Up @@ -37,13 +46,6 @@ halo:
- "/path/to/plugin-search-widget"
```

## 使用方式

1.[Releases](https://github.com/halo-sigs/plugin-search-widget/releases) 下载最新的 JAR 文件。
2. 在 Halo 后台的插件管理上传 JAR 文件进行安装。

> 需要注意的是,此插件需要主题进行适配,不会主动显示搜索入口。
## 主题适配

此插件是一个通用的搜索框插件,主题需要做的只是通过 JS API 唤起搜索框即可,以下是代码示例:
Expand Down

0 comments on commit 473f70d

Please sign in to comment.