diff --git a/README.md b/README.md index 857be0d..df514bb 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,16 @@ -# plugin-starter +# plugin-multiple-content-show -Halo 2.0 插件开发快速开始模板。 +为halo站点的单页面和文章集成 swiper幻灯片、PDF等文件展示功能！ -## 开发环境 +## 其他 -插件开发的详细文档请查阅： +... 正在开发中，如果 有什么好的建议和想法可以加入如下渠道进行交流 -所需环境： +QQ交流群与QQ频道，加群后管理员自动审核 +
+   +   +
-1. Java 17 -2. Node 18 -3. pnpm 8 -4. Docker (可选) -克隆项目： -```bash -git clone git@github.com:halo-sigs/plugin-starter.git - -# 或者当你 fork 之后 - -git clone git@github.com:{your_github_id}/plugin-starter.git -``` - -```bash -cd path/to/plugin-starter -``` - -### 运行方式 1（推荐） - -> 此方式需要本地安装 Docker - -```bash -# macOS / Linux -./gradlew pnpmInstall - -# Windows -./gradlew.bat pnpmInstall -``` - -```bash -# macOS / Linux -./gradlew haloServer - -# Windows -./gradlew.bat haloServer -``` - -执行此命令后，会自动创建一个 Halo 的 Docker 容器并加载当前的插件，更多文档可查阅： - -### 运行方式 2 - -> 此方式需要使用源码运行 Halo - -编译插件： - -```bash -# macOS / Linux -./gradlew build - -# Windows -./gradlew.bat build -``` - -修改 Halo 配置文件： - -```yaml -halo: - plugin: - runtime-mode: development - fixedPluginPath: - - "/path/to/plugin-starter" -``` - -最后重启 Halo 项目即可。