diff --git a/README.md b/README.md index f35ce79..7763760 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,66 @@ # plugin-comment-widget -Halo 2.0 的评论模块插件,为前台提供完整的评论解决方案(WIP) +Halo 2.0 的通用评论组件插件,为前台提供完整的评论解决方案。 -## 说明 +## 开发环境 -使用 Vue 构建评论组件,最终产物(`comment-widget.iife.js` `style.css`)会被放置于 `src/main/resources/static`,插件需要配置 `ReverseProxy` 资源,如: +```bash +git clone git@github.com:halo-sigs/plugin-comment-widget.git -```yaml -apiVersion: plugin.halo.run/v1alpha1 -kind: ReverseProxy -metadata: - name: reverse-proxy-comment-widget -rules: - - path: /static/** - file: - directory: static -``` +# 或者当你 fork 之后 -最终可通过 `/assets/PluginCommentWidget/static/comment-widget.iife.js` 访问到评论组件的 JavaScript 资源。 +git clone git@github.com:{your_github_id}/plugin-comment-widget.git +``` -根据 [RFC](https://github.com/halo-dev/rfcs/tree/main/theme#%E4%B8%BB%E9%A2%98%E5%85%AC%E5%85%B1%E6%A8%A1%E6%9D%BF%E6%89%A9%E5%B1%95),最终主题使用该插件需要在对应扩展点插入以下代码: +```bash +cd path/to/plugin-comment-widget +``` -```html -
- - +```bash +./gradlew build ``` -如果使用 Vue 构建 SPA 应用,也可以使用以下方式引入评论组件: +修改 Halo 配置文件: -```bash -pnpm install @halo-dev/comment-widget +```yaml +halo: + plugin: + runtime-mode: development + classes-directories: + - "build/classes" + - "build/resources" + lib-directories: + - "libs" + fixedPluginPath: + - "/path/to/plugin-comment-widget" ``` -```vue - +## 使用方式 + +1. 在 [Releases](https://github.com/halo-sigs/plugin-comment-widget/releases) 下载最新的 JAR 文件。 +2. 在 Halo 后台的插件管理上传 JAR 文件进行安装。 + +> 需要注意的是,此插件需要主题进行适配,不会主动在内容页加载评论组件。 + +## 主题适配 + +此插件是一个通用的评论组件插件,主题需要针对此类型插件做适配。Halo 为模板引擎提供了专门的标签(