halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-20 17:54:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: documentation structure (#310)

Browse Source 
重构文档结构，将开发者文档与使用文档分开。

<img width="641" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/baed360c-997b-443c-9a8e-cc53e268b8f4">
<img width="766" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/08326aab-d474-4075-bdc9-c628a39ba715">


Note: 此改动不造成死链。

```release-note
None
```
This commit is contained in:
Ryan Wang
2024-02-05 18:00:13 +08:00
committed by GitHub
parent d0ea59e6e2
commit 97e0b2b526
15 changed files with 1872 additions and 2010 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docusaurus.config.js
View File

@@ -78,12 +78,16 @@ const config = {
},
items: [
{
href: "https://halo.run",
label: "官网",
type: "docSidebar",
position: "left",
sidebarId: "tutorial",
label: "使用指南",
},
{
href: "https://bbs.halo.run",
label: "论坛",
type: "docSidebar",
position: "left",
sidebarId: "developer",
label: "开发者指南",
},
{
type: "docsVersionDropdown",
@@ -106,6 +110,16 @@ const config = {
},
],
},
{
href: "https://halo.run",
label: "官网",
position: "right",
},
{
href: "https://bbs.halo.run",
label: "论坛",
position: "right",
},
{
href: "https://github.com/halo-dev/halo",
label: "GitHub",

22
sidebars.js
View File

@@ -14,7 +14,7 @@ module.exports = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
tutorialSidebar: [
tutorial: [
"intro",
{
type: "category",
@@ -81,11 +81,16 @@ module.exports = {
},
{
type: "category",
label: "开发者指南",
label: "参与贡献",
link: {
type: "generated-index",
},
items: [
items: ["contribution/issue", "contribution/pr", "contribution/sponsor"],
},
"about",
],
developer: [
{
type: "category",
label: "系统开发",
@@ -323,15 +328,4 @@ module.exports = {
// href: "https://api.halo.run",
// },
],
},
{
type: "category",
label: "参与贡献",
link: {
type: "generated-index",
},
items: ["contribution/issue", "contribution/pr", "contribution/sponsor"],
},
"about",
],
};

25
versioned_sidebars/version-2.0-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -22,9 +22,7 @@
{
"type": "category",
"label": "其他指南",
"items": [
"getting-started/install/other/nginxproxymanager"
]
"items": ["getting-started/install/other/nginxproxymanager"]
}
]
},
@@ -52,11 +50,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -135,15 +137,4 @@
},
"developer-guide/form-schema"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": ["contribution/issue", "contribution/pr"]
},
"about"
]
}

28
versioned_sidebars/version-2.1-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -53,11 +53,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -76,9 +80,7 @@
"link": {
"type": "generated-index"
},
"items": [
"developer-guide/plugin/prepare"
]
"items": ["developer-guide/plugin/prepare"]
},
{
"type": "category",
@@ -141,18 +143,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

29
versioned_sidebars/version-2.10-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -60,11 +60,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr", "contribution/sponsor"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -110,9 +114,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -191,19 +193,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr",
"contribution/sponsor"
]
},
"about"
]
}

29
versioned_sidebars/version-2.11-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -62,11 +62,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr", "contribution/sponsor"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -112,9 +116,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -194,19 +196,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr",
"contribution/sponsor"
]
},
"about"
]
}

29
versioned_sidebars/version-2.12-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -63,11 +63,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr", "contribution/sponsor"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -231,9 +235,7 @@
"link": {
"type": "generated-index"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
}
]
},
@@ -299,19 +301,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr",
"contribution/sponsor"
]
},
"about"
]
}

21
versioned_sidebars/version-2.2-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -53,11 +53,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -182,15 +186,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": ["contribution/issue", "contribution/pr"]
},
"about"
]
}

28
versioned_sidebars/version-2.3-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -54,11 +54,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -104,9 +108,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -185,18 +187,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

28
versioned_sidebars/version-2.4-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -54,11 +54,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -104,9 +108,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -185,18 +187,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

28
versioned_sidebars/version-2.5-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -54,11 +54,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -104,9 +108,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -185,18 +187,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

21
versioned_sidebars/version-2.6-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -58,11 +58,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -187,15 +191,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": ["contribution/issue", "contribution/pr"]
},
"about"
]
}

28
versioned_sidebars/version-2.7-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -58,11 +58,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -108,9 +112,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -189,18 +191,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

28
versioned_sidebars/version-2.8-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -59,11 +59,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -109,9 +113,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -190,18 +192,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}

28
versioned_sidebars/version-2.9-sidebars.json
View File

@@ -1,5 +1,5 @@
{
"tutorialSidebar": [
"tutorial": [
"intro",
{
"type": "category",
@@ -60,11 +60,15 @@
},
{
"type": "category",
"label": "开发者指南",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"items": ["contribution/issue", "contribution/pr"]
},
"about"
],
"developer": [
{
"type": "category",
"label": "系统开发",
@@ -110,9 +114,7 @@
"type": "doc",
"id": "developer-guide/plugin/examples/todolist"
},
"items": [
"developer-guide/plugin/examples/todolist"
]
"items": ["developer-guide/plugin/examples/todolist"]
},
{
"type": "category",
@@ -191,18 +193,4 @@
"developer-guide/form-schema",
"developer-guide/annotations-form"
]
},
{
"type": "category",
"label": "参与贡献",
"link": {
"type": "generated-index"
},
"items": [
"contribution/issue",
"contribution/pr"
]
},
"about"
]
}