docs: refactor documentation of plugin development (#291)

重构和完善插件开发文档。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/253

```release-note
None
```

---------

Signed-off-by: Ryan Wang <i@ryanc.cc>
Co-authored-by: guqing <i@guqing.email>
This commit is contained in:
Ryan Wang
2024-01-30 16:00:18 +08:00
committed by GitHub
parent 5e15e35b29
commit 6a253dd896
92 changed files with 4917 additions and 567 deletions

View File

@@ -114,40 +114,145 @@ module.exports = {
type: "category",
label: "基础",
link: {
type: "doc",
id: "developer-guide/plugin/structure",
type: "generated-index",
},
items: [
"developer-guide/plugin/structure",
"developer-guide/plugin/runtime-mode",
"developer-guide/plugin/lifecycle",
"developer-guide/plugin/manifest",
"developer-guide/plugin/object-management",
"developer-guide/plugin/basics/framework",
"developer-guide/plugin/basics/structure",
"developer-guide/plugin/basics/manifest",
"developer-guide/plugin/basics/devtools",
{
type: "category",
label: "服务端",
link: {
type: "generated-index",
},
items: [
"developer-guide/plugin/basics/server/lifecycle",
"developer-guide/plugin/basics/server/object-management",
],
},
{
type: "category",
label: "UI",
link: {
type: "generated-index",
},
items: [
"developer-guide/plugin/basics/ui/intro",
"developer-guide/plugin/basics/ui/entry",
],
},
],
},
{
type: "category",
label: "示例",
link: {
type: "doc",
id: "developer-guide/plugin/examples/todolist",
},
items: ["developer-guide/plugin/examples/todolist"],
},
{
type: "category",
label: "API 参考",
link: {
type: "doc",
id: "developer-guide/plugin/api-reference/extension",
type: "generated-index",
},
items: [
"developer-guide/plugin/api-reference/extension",
"developer-guide/plugin/api-reference/role-template",
"developer-guide/plugin/api-reference/extension-client",
"developer-guide/plugin/api-reference/reverseproxy",
{
type: "category",
label: "服务端",
link: {
type: "generated-index",
},
items: [
"developer-guide/plugin/api-reference/server/extension",
"developer-guide/plugin/api-reference/server/reconciler",
"developer-guide/plugin/api-reference/server/role-template",
"developer-guide/plugin/api-reference/server/extension-client",
"developer-guide/plugin/api-reference/server/reverseproxy",
"developer-guide/plugin/api-reference/server/finder-for-theme",
"developer-guide/plugin/api-reference/server/template-for-theme",
{
type: "category",
label: "扩展点",
link: {
type: "doc",
id: "developer-guide/plugin/api-reference/server/extension-points/index",
},
items: [
"developer-guide/plugin/api-reference/server/extension-points/additional-webfilter",
"developer-guide/plugin/api-reference/server/extension-points/attachment",
"developer-guide/plugin/api-reference/server/extension-points/comment-subject",
"developer-guide/plugin/api-reference/server/extension-points/comment-widget",
"developer-guide/plugin/api-reference/server/extension-points/notifier",
"developer-guide/plugin/api-reference/server/extension-points/post-content",
"developer-guide/plugin/api-reference/server/extension-points/singlepage-content",
"developer-guide/plugin/api-reference/server/extension-points/username-password-authentication-manager",
],
},
],
},
{
type: "category",
label: "UI",
link: {
type: "generated-index",
},
items: [
"developer-guide/plugin/api-reference/ui/route",
{
type: "category",
label: "扩展点",
link: {
type: "doc",
id: "developer-guide/plugin/api-reference/ui/extension-points/index",
},
items: [
"developer-guide/plugin/api-reference/ui/extension-points/attachment-selector-create",
"developer-guide/plugin/api-reference/ui/extension-points/editor-create",
"developer-guide/plugin/api-reference/ui/extension-points/plugin-self-tabs-create",
"developer-guide/plugin/api-reference/ui/extension-points/default-editor-extension-create",
"developer-guide/plugin/api-reference/ui/extension-points/comment-subject-ref-create",
"developer-guide/plugin/api-reference/ui/extension-points/backup-tabs-create",
"developer-guide/plugin/api-reference/ui/extension-points/plugin-installation-tabs-create",
"developer-guide/plugin/api-reference/ui/extension-points/theme-list-tabs-create",
"developer-guide/plugin/api-reference/ui/extension-points/post-list-item-operation-create",
"developer-guide/plugin/api-reference/ui/extension-points/plugin-list-item-operation-create",
"developer-guide/plugin/api-reference/ui/extension-points/backup-list-item-operation-create",
"developer-guide/plugin/api-reference/ui/extension-points/attachment-list-item-operation-create",
"developer-guide/plugin/api-reference/ui/extension-points/theme-list-item-operation-create",
"developer-guide/plugin/api-reference/ui/extension-points/plugin-list-item-field-create",
"developer-guide/plugin/api-reference/ui/extension-points/post-list-item-field-create",
],
},
{
type: "category",
label: "组件",
link: {
type: "doc",
id: "developer-guide/plugin/api-reference/ui/components/index",
},
items: [
"developer-guide/plugin/api-reference/ui/components/uppy-upload",
"developer-guide/plugin/api-reference/ui/components/filter-dropdown",
"developer-guide/plugin/api-reference/ui/components/filter-clean-button",
"developer-guide/plugin/api-reference/ui/components/annotations-form",
"developer-guide/plugin/api-reference/ui/components/attachment-file-type-icon",
"developer-guide/plugin/api-reference/ui/components/attachment-selector-modal",
"developer-guide/plugin/api-reference/ui/components/has-permission",
"developer-guide/plugin/api-reference/ui/components/search-input",
"developer-guide/plugin/api-reference/ui/components/v-codemirror",
"developer-guide/plugin/api-reference/ui/components/v-tooltip",
"developer-guide/plugin/api-reference/ui/components/v-permission",
],
},
],
},
],
},
{
type: "category",
label: "案例和最佳实践",
link: {
type: "generated-index",
},
items: ["developer-guide/plugin/examples/todolist"],
},
// "developer-guide/plugin/appendices",
],
},
{