Skip to content

Commit

Permalink
docs: update usage documentation of readme file (#44)
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Wang <i@ryanc.cc>
  • Loading branch information
ruibaby committed Jul 12, 2023
1 parent 7544f69 commit a8b3bc0
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

Halo 2.0 的通用评论组件插件,为前台提供完整的评论解决方案。

## 使用方式

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

> 需要注意的是,此插件需要主题进行适配,不会主动在内容页加载评论组件。
## 开发环境

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

## 使用方式

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

> 需要注意的是,此插件需要主题进行适配,不会主动在内容页加载评论组件。
## 主题适配

此插件是一个通用的评论组件插件,主题需要针对此类型插件做适配。Halo 为模板引擎提供了专门的标签(<halo:comment />),只需要在必要的位置添加此标签即可。
Expand Down

0 comments on commit a8b3bc0

Please sign in to comment.