From 4b934c0ace0fcff13bd6a2cb06b8171e10eebfad Mon Sep 17 00:00:00 2001 From: Simple Date: Fri, 26 May 2023 23:48:13 +0800 Subject: [PATCH] docs: add configuration examples for the Windows platform in the plugin-related documents (#219) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Halo 插件开发 Windows 环境下插件绝对路径的补充 Ref #218 /kind documentation ```release-note None ``` --- docs/developer-guide/plugin/hello-world.md | 9 +++++++++ docs/developer-guide/plugin/runtime-mode.md | 11 ++++++++++- .../developer-guide/plugin/hello-world.md | 9 +++++++++ .../developer-guide/plugin/runtime-mode.md | 12 +++++++++++- 4 files changed, 39 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/plugin/hello-world.md b/docs/developer-guide/plugin/hello-world.md index 4aed17c..e09fad1 100644 --- a/docs/developer-guide/plugin/hello-world.md +++ b/docs/developer-guide/plugin/hello-world.md @@ -30,12 +30,21 @@ Halo 提供了一个模板仓库用于创建插件: 然后在 `src/main/resources` 下创建一个 `application-local.yaml` 文件并做如下配置: ```yaml +# macOS / Linux halo: plugin: runtime-mode: development fixed-plugin-path: # 配置为插件绝对路径 - /Users/guqing/halo-plugin-hello-world + +# Windows +halo: + plugin: + runtime-mode: development + fixed-plugin-path: + # 配置为插件绝对路径 + - C:\Users\guqing\halo-plugin-hello-world ``` 使用此 local profile 启动 Halo: diff --git a/docs/developer-guide/plugin/runtime-mode.md b/docs/developer-guide/plugin/runtime-mode.md index e0e6707..811e782 100644 --- a/docs/developer-guide/plugin/runtime-mode.md +++ b/docs/developer-guide/plugin/runtime-mode.md @@ -23,11 +23,20 @@ halo: 而如果你想以 `DEVELOPMENT` 运行插件或开发插件则将 `runtime-mode` 修改为 `development`,同时配置 `fixed-plugin-path` 为插件项目路径,可以配置多个。 ```yaml +# macOS / Linux +plugin: + runtime-mode: development + fixed-plugin-path: + # 配置为插件绝对路径 + - /Users/guqing/halo-plugin-hello-world + +# Windows halo: plugin: runtime-mode: development fixed-plugin-path: - - /path/to/your/plugin/plugin-starter + # 配置为插件绝对路径 + - C:\Users\guqing\halo-plugin-hello-world ``` :::tip Note diff --git a/versioned_docs/version-2.5/developer-guide/plugin/hello-world.md b/versioned_docs/version-2.5/developer-guide/plugin/hello-world.md index 4aed17c..1257ba5 100644 --- a/versioned_docs/version-2.5/developer-guide/plugin/hello-world.md +++ b/versioned_docs/version-2.5/developer-guide/plugin/hello-world.md @@ -30,12 +30,21 @@ Halo 提供了一个模板仓库用于创建插件: 然后在 `src/main/resources` 下创建一个 `application-local.yaml` 文件并做如下配置: ```yaml +# macOS / Linux halo: plugin: runtime-mode: development fixed-plugin-path: # 配置为插件绝对路径 - /Users/guqing/halo-plugin-hello-world + +# Windows +halo: + plugin: + runtime-mode: development + fixed-plugin-path: + # 配置为插件绝对路径 + - C:\Users\guqing\halo-plugin-hello-world ``` 使用此 local profile 启动 Halo: diff --git a/versioned_docs/version-2.5/developer-guide/plugin/runtime-mode.md b/versioned_docs/version-2.5/developer-guide/plugin/runtime-mode.md index e0e6707..dd2daa5 100644 --- a/versioned_docs/version-2.5/developer-guide/plugin/runtime-mode.md +++ b/versioned_docs/version-2.5/developer-guide/plugin/runtime-mode.md @@ -23,11 +23,21 @@ halo: 而如果你想以 `DEVELOPMENT` 运行插件或开发插件则将 `runtime-mode` 修改为 `development`,同时配置 `fixed-plugin-path` 为插件项目路径,可以配置多个。 ```yaml +# macOS / Linux +plugin: + runtime-mode: development + fixed-plugin-path: + # 配置为插件绝对路径 + - /Users/guqing/halo-plugin-hello-world + +# Windows halo: plugin: runtime-mode: development fixed-plugin-path: - - /path/to/your/plugin/plugin-starter + # 配置为插件绝对路径 + - C:\Users\guqing\halo-plugin-hello-world + ``` :::tip Note