From 7e0fbd85be95975f80ac663f2ed6a3b5166288e8 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Tue, 30 Apr 2024 12:41:56 +0800 Subject: [PATCH] docs: add issues field for theme and plugin manifest example (#342) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 为主题和插件的配置文件示例添加 issues 字段。 Ref https://github.com/halo-dev/halo/pull/5755 /kind documentation ```release-note None ``` --- docs/developer-guide/plugin/basics/manifest.md | 2 ++ docs/developer-guide/plugin/examples/todolist.md | 1 + docs/developer-guide/theme/config.md | 2 ++ docs/developer-guide/theme/prepare.md | 1 + docs/developer-guide/theme/settings.md | 1 + 5 files changed, 7 insertions(+) diff --git a/docs/developer-guide/plugin/basics/manifest.md b/docs/developer-guide/plugin/basics/manifest.md index 14ef27f4..be88fe16 100644 --- a/docs/developer-guide/plugin/basics/manifest.md +++ b/docs/developer-guide/plugin/basics/manifest.md @@ -21,6 +21,7 @@ spec: # configMapName: hello-world-configmap homepage: https://github.com/halo-dev/plugin-starter#readme repo: https://github.com/halo-dev/plugin-starter + issues: https://github.com/halo-dev/plugin-starter/issues displayName: "插件 Hello world" description: "插件开发的 hello world，用于学习如何开发一个简单的 Halo 插件" license: @@ -52,6 +53,7 @@ spec: - `spec.homepage`：通常设置为插件官网或帮助中心链接等。 - `spec.repo`：插件源码地址。 +- `spec.issues`：插件问题反馈地址，如果你的插件是开源在 GitHub 上，可以直接配置为 GitHub Issues 地址。 - `spec.displayName`：插件的显示名称，它通常是以少数几个字来概括插件的用途。 - `spec.description`：插件描述，用一段简短的说明来介绍插件的用途。 - `spec.license`：插件使用的软件协议，参考：。 diff --git a/docs/developer-guide/plugin/examples/todolist.md b/docs/developer-guide/plugin/examples/todolist.md index 60b5c4b0..f73ff5a0 100644 --- a/docs/developer-guide/plugin/examples/todolist.md +++ b/docs/developer-guide/plugin/examples/todolist.md @@ -37,6 +37,7 @@ description: 这个例子展示了如何开发 Todo List 插件 logo: https://halo.run/logo homepage: https://github.com/halo-dev/plugin-starter#readme repo: https://github.com/halo-dev/plugin-starter + issues: https://github.com/halo-dev/plugin-starter/issues displayName: "插件 Todo List" description: "插件开发的 hello world，用于学习如何开发一个简单的 Halo 插件" license: diff --git a/docs/developer-guide/theme/config.md b/docs/developer-guide/theme/config.md index 77b376ee..eafaa347 100644 --- a/docs/developer-guide/theme/config.md +++ b/docs/developer-guide/theme/config.md @@ -21,6 +21,7 @@ spec: logo: https://www.halo.run/logo homepage: https://github.com/halo-sigs/theme-foo repo: https://github.com/halo-sigs/theme-foo.git + issues: https://github.com/halo-sigs/theme-foo/issues settingName: "theme-foo-setting" configMapName: "theme-foo-configMap" customTemplates: @@ -58,6 +59,7 @@ spec: | `spec.logo` | 主题 Logo | 否 | | `spec.homepage` | 主题网站 | 否 | | `spec.repo` | 主题代码托管地址 | 否 | +| `spec.issues` | 主题问题反馈地址，如果你的主题是开源在 GitHub 上，可以直接配置为 GitHub Issues 地址。 | 否 | | `spec.settingName` | 设置表单定义的名称，需要同时创建对应的 `settings.yaml` 文件 | 否 | | `spec.configMapName` | 设置持久化配置的 ConfigMap 名称 | 否 | | `spec.customTemplates.post` | 文章的自定义模板配置，详细文档可查阅 [模板路由](./template-route-mapping#custom-templates) | 否 | diff --git a/docs/developer-guide/theme/prepare.md b/docs/developer-guide/theme/prepare.md index f58b2030..aae60ab4 100644 --- a/docs/developer-guide/theme/prepare.md +++ b/docs/developer-guide/theme/prepare.md @@ -42,6 +42,7 @@ spec: logo: https://www.halo.run/logo homepage: https://github.com/halo-sigs/theme-foo repo: https://github.com/halo-sigs/theme-foo.git + issues: https://github.com/halo-sigs/theme-foo/issues settingName: "theme-foo-setting" configMapName: "theme-foo-configMap" version: 1.0.0 diff --git a/docs/developer-guide/theme/settings.md b/docs/developer-guide/theme/settings.md index afd8912e..77323168 100644 --- a/docs/developer-guide/theme/settings.md +++ b/docs/developer-guide/theme/settings.md @@ -29,6 +29,7 @@ spec: logo: https://www.halo.run/logo homepage: https://github.com/halo-sigs/theme-foo repo: https://github.com/halo-sigs/theme-foo.git + issues: https://github.com/halo-sigs/theme-foo/issues settingName: "theme-foo-setting" configMapName: "theme-foo-configMap" version: 1.0.0