From 1f909ec149add35258501d55778dff686ebacb67 Mon Sep 17 00:00:00 2001 From: huyikai Date: Thu, 14 Dec 2023 15:45:44 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=F0=9F=8E=B8=20Improve=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.ts | 9 ++++++- docs/.vitepress/theme/home.vue | 4 +-- docs/Guide/Basic/Features/CMS.md | 25 +++++++++++++++++++ docs/Guide/Basic/Features/Home.md | 3 +++ docs/Guide/Basic/Features/Nav.md | 12 +++++++++ docs/Guide/Basic/Features/Sidebar.md | 10 ++++++++ docs/Guide/Basic/Introduction.md | 13 ++++++++++ docs/contents/Guide/1.Introduction/Started.md | 19 -------------- docs/contents/Guide/2.Features/Nav.md | 7 ------ docs/contents/Guide/2.Features/Sidebar.md | 7 ------ docs/contents/Guide/test.md | 1 - docs/contents/test.md | 1 - .../Guide2/1.Introduction2/Started.md | 19 -------------- .../Guide2/1.Introduction2/test123/test123.md | 0 docs/contents2/Guide2/2.Features/Nav.md | 7 ------ docs/contents2/Guide2/2.Features/Sidebar.md | 7 ------ docs/contents2/Guide2/test.md | 1 - docs/index.md | 5 +++- .../@huyikai/vitepress-helper/package.json | 2 +- .../template/docs/.vitepress/config.ts | 11 ++++++-- .../template/docs/.vitepress/theme/home.vue | 4 +-- .../template/docs/Introduction.md | 5 ++++ .../template/docs/content}/class1/class1-a.md | 0 .../template/docs/content}/class1/class1-b.md | 0 .../content}/class1/class2-1/class2-1-a.md | 0 .../content}/class1/class2-2/class2-2-a.md | 0 .../content}/class1/class2-2/class2-2-b.md | 0 .../class1/class2-2/class3/class3-a.md | 0 .../class1/class2-2/class3/class3-b.md | 0 .../template/docs/example/class1/class1-a.md | 0 .../template/docs/example/class1/class1-b.md | 0 .../example/class1/class2-1/class2-1-a.md | 0 .../example/class1/class2-2/class2-2-a.md | 0 .../example/class1/class2-2/class2-2-b.md | 0 .../class1/class2-2/class3/class3-a.md | 0 .../class1/class2-2/class3/class3-b.md | 0 36 files changed, 94 insertions(+), 78 deletions(-) create mode 100644 docs/Guide/Basic/Features/CMS.md create mode 100644 docs/Guide/Basic/Features/Home.md create mode 100644 docs/Guide/Basic/Features/Nav.md create mode 100644 docs/Guide/Basic/Features/Sidebar.md create mode 100644 docs/Guide/Basic/Introduction.md delete mode 100644 docs/contents/Guide/1.Introduction/Started.md delete mode 100644 docs/contents/Guide/2.Features/Nav.md delete mode 100644 docs/contents/Guide/2.Features/Sidebar.md delete mode 100644 docs/contents/Guide/test.md delete mode 100644 docs/contents/test.md delete mode 100644 docs/contents2/Guide2/1.Introduction2/Started.md delete mode 100644 docs/contents2/Guide2/1.Introduction2/test123/test123.md delete mode 100644 docs/contents2/Guide2/2.Features/Nav.md delete mode 100644 docs/contents2/Guide2/2.Features/Sidebar.md delete mode 100644 docs/contents2/Guide2/test.md create mode 100644 packages/@huyikai/vitepress-helper/template/docs/Introduction.md rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class1-a.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class1-b.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class2-1/class2-1-a.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class2-2/class2-2-a.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class2-2/class2-2-b.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class2-2/class3/class3-a.md (100%) rename {docs/contents2 => packages/@huyikai/vitepress-helper/template/docs/content}/class1/class2-2/class3/class3-b.md (100%) delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-a.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-b.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-1/class2-1-a.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-a.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-b.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-a.md delete mode 100644 packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-b.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c95576f..1e2a2cb 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -25,7 +25,14 @@ export default async () => { ...instance.nav, { text: 'Example', - link: 'https://huyikai.xyz' + items: [ + { text: 'MySite', link: 'https://huyikai.xyz' }, + { + text: 'Tree-Conver', + link: 'https://huyikai.github.io/tree-conver/' + }, + { text: 'LocalCMS', link: 'https://huyikai.github.io/local-cms/' } + ] } ], // 侧边栏 diff --git a/docs/.vitepress/theme/home.vue b/docs/.vitepress/theme/home.vue index 23ba015..f548a71 100644 --- a/docs/.vitepress/theme/home.vue +++ b/docs/.vitepress/theme/home.vue @@ -17,8 +17,8 @@ import VPButton from 'vitepress/dist/client/theme-default/components/VPButton.vu tag="a" size="medium" theme="brand" - text="Docs" - href="/contents/Guide/1.Introduction/Started.html" + text="Guide" + href="/Guide/Basic/Introduction.html" > { // 导航栏 nav: [ ...instance.nav, + // 可以自定义添加导航栏的额外内容 { - // 可以自定义添加导航栏的额外内容 text: 'Example', - link: 'https://huyikai.xyz' + items: [ + { text: 'MySite', link: 'https://huyikai.xyz' }, + { + text: 'Tree-Conver', + link: 'https://huyikai.github.io/tree-conver/' + }, + { text: 'LocalCMS', link: 'https://huyikai.github.io/local-cms/' } + ] } ], // 侧边栏 diff --git a/packages/@huyikai/vitepress-helper/template/docs/.vitepress/theme/home.vue b/packages/@huyikai/vitepress-helper/template/docs/.vitepress/theme/home.vue index 23ba015..b97200c 100644 --- a/packages/@huyikai/vitepress-helper/template/docs/.vitepress/theme/home.vue +++ b/packages/@huyikai/vitepress-helper/template/docs/.vitepress/theme/home.vue @@ -18,7 +18,7 @@ import VPButton from 'vitepress/dist/client/theme-default/components/VPButton.vu size="medium" theme="brand" text="Docs" - href="/contents/Guide/1.Introduction/Started.html" + href="/Introduction.html" > diff --git a/packages/@huyikai/vitepress-helper/template/docs/Introduction.md b/packages/@huyikai/vitepress-helper/template/docs/Introduction.md new file mode 100644 index 0000000..a741222 --- /dev/null +++ b/packages/@huyikai/vitepress-helper/template/docs/Introduction.md @@ -0,0 +1,5 @@ +# VitePress-Helper + +## Brief + +On the basis of [vitepress](https://vitepress.vuejs.org), optimize the user experience. diff --git a/docs/contents2/class1/class1-a.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class1-a.md similarity index 100% rename from docs/contents2/class1/class1-a.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class1-a.md diff --git a/docs/contents2/class1/class1-b.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class1-b.md similarity index 100% rename from docs/contents2/class1/class1-b.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class1-b.md diff --git a/docs/contents2/class1/class2-1/class2-1-a.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-1/class2-1-a.md similarity index 100% rename from docs/contents2/class1/class2-1/class2-1-a.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-1/class2-1-a.md diff --git a/docs/contents2/class1/class2-2/class2-2-a.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class2-2-a.md similarity index 100% rename from docs/contents2/class1/class2-2/class2-2-a.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class2-2-a.md diff --git a/docs/contents2/class1/class2-2/class2-2-b.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class2-2-b.md similarity index 100% rename from docs/contents2/class1/class2-2/class2-2-b.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class2-2-b.md diff --git a/docs/contents2/class1/class2-2/class3/class3-a.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class3/class3-a.md similarity index 100% rename from docs/contents2/class1/class2-2/class3/class3-a.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class3/class3-a.md diff --git a/docs/contents2/class1/class2-2/class3/class3-b.md b/packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class3/class3-b.md similarity index 100% rename from docs/contents2/class1/class2-2/class3/class3-b.md rename to packages/@huyikai/vitepress-helper/template/docs/content/class1/class2-2/class3/class3-b.md diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-a.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-a.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-b.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class1-b.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-1/class2-1-a.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-1/class2-1-a.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-a.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-a.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-b.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class2-2-b.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-a.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-a.md deleted file mode 100644 index e69de29..0000000 diff --git a/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-b.md b/packages/@huyikai/vitepress-helper/template/docs/example/class1/class2-2/class3/class3-b.md deleted file mode 100644 index e69de29..0000000