diff --git a/packages/docs/.vitepress/config.ts b/packages/docs/.vitepress/config.ts index dbaab53..4aece01 100644 --- a/packages/docs/.vitepress/config.ts +++ b/packages/docs/.vitepress/config.ts @@ -24,7 +24,7 @@ export default defineConfigWithTheme({ nav: [ { text: '指南', - link: '/guide/introduction/', + link: '/guide/intro/', activeMatch: '/guide/' } ], diff --git a/packages/docs/guide/blog/frontmatter.md b/packages/docs/guide/blog/frontmatter.md deleted file mode 100644 index 4b9cab1..0000000 --- a/packages/docs/guide/blog/frontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -# frontmatter - -待补充 diff --git a/packages/docs/guide/blog/index.md b/packages/docs/guide/blog/index.md deleted file mode 100644 index 3c12c04..0000000 --- a/packages/docs/guide/blog/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar: - order: 7 - title: 博客布局 ---- - -# 博客页 - -待补充 diff --git a/packages/docs/guide/introduction/deploy.md b/packages/docs/guide/intro/deploy.md similarity index 100% rename from packages/docs/guide/introduction/deploy.md rename to packages/docs/guide/intro/deploy.md diff --git a/packages/docs/guide/intro/index.md b/packages/docs/guide/intro/index.md new file mode 100644 index 0000000..f340276 --- /dev/null +++ b/packages/docs/guide/intro/index.md @@ -0,0 +1,30 @@ +--- +sidebar: + order: 9 + title: 简介 + text: 概述 +--- + +# 概述 + +`VitePress Theme Mild` 以下简称(Mild Theme), 是一个且具备丰富能力的 VitePress 主题, 它基于默认主题开发, 保留了原有的默认主题的配置规则, 并在此基础上进行扩展, 加入了更多可自定义的配置项, 以及丰富的markdown能力, 并额外提供了更多布局, 例如: blog, 可以帮助你快速搭建个人博客或者技术文档. + +## 为什么开发这个主题 + +[开发VitePress主题的初衷](https://hacxy.cn/docs/posts/dev-vitepress-theme/1.start.html) + +## 案例 + +以下是正在使用这个主题的项目 + +**博客案例:** + +- [hacxy.cn](https://hacxy.cn) + +**文档案例** + +- [vitepress-theme-mild](https://theme.hacxy.cn) + +## 快速开始 + +[下一章: 快速开始](./quick-start.md) diff --git a/packages/docs/guide/introduction/quick-start.md b/packages/docs/guide/intro/quick-start.md similarity index 100% rename from packages/docs/guide/introduction/quick-start.md rename to packages/docs/guide/intro/quick-start.md diff --git a/packages/docs/guide/introduction/index.md b/packages/docs/guide/introduction/index.md deleted file mode 100644 index 63e3e2f..0000000 --- a/packages/docs/guide/introduction/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar: - order: 9 - title: 简介 - text: 概述 ---- - -# 概述 - -`VitePress Theme Mild` 是一个使用简单且具备丰富能力的 VitePress 主题, 它基于默认主题开发, 并额外提供了博客布局, 帮助你快速搭建个人博客或者技术文档. - -## 为什么开发这个主题 - -[开发VitePress主题的初衷](https://hacxy.cn/docs/posts/dev-vitepress-theme/1.start.html) - -## 案例 - -以下是正在使用这个主题的项目 - -**博客案例:** - -- [hacxy.cn](https://hacxy.cn) - -**文档案例** - -- [vitepress-theme-mild](https://theme.hacxy.cn) diff --git a/packages/docs/guide/layout/blog.md b/packages/docs/guide/layout/blog.md new file mode 100644 index 0000000..0b874b5 --- /dev/null +++ b/packages/docs/guide/layout/blog.md @@ -0,0 +1 @@ +# 博客页布局 diff --git a/packages/docs/guide/layout/doc.md b/packages/docs/guide/layout/doc.md new file mode 100644 index 0000000..9261478 --- /dev/null +++ b/packages/docs/guide/layout/doc.md @@ -0,0 +1 @@ +# 文档页布局 diff --git a/packages/docs/guide/layout/index.md b/packages/docs/guide/layout/index.md new file mode 100644 index 0000000..6a2648c --- /dev/null +++ b/packages/docs/guide/layout/index.md @@ -0,0 +1,6 @@ +--- +sidebar: + title: 布局 +--- + +# 概述 diff --git a/packages/docs/guide/layout/tag.md b/packages/docs/guide/layout/tag.md new file mode 100644 index 0000000..3ce0a4b --- /dev/null +++ b/packages/docs/guide/layout/tag.md @@ -0,0 +1 @@ +# 标签页布局 diff --git a/packages/docs/guide/sidebar/index.md b/packages/docs/guide/sidebar/index.md index 8d71e00..e89915d 100644 --- a/packages/docs/guide/sidebar/index.md +++ b/packages/docs/guide/sidebar/index.md @@ -1,9 +1,40 @@ --- -sidebar: - title: 侧边栏 - order: 8 +sidebar: false --- -# 介绍 +# 概述 -待补充 +`Mild Theme` 基于默认主题扩展了一项非常实用的能力, 它由默认主题提供的 [sidebar 配置](https://vitepress.dev/zh/reference/default-theme-sidebar) 所 "进化" 而来, 保留了原有的配置规则, 并提供了一个自动扫描文件路径生成侧边栏的选项. + +## 自动侧边栏 + +自动侧边栏基于多侧边栏实现, 可以根据不同的页面路径来显示不同的侧边栏, 例如: 希望在文档中创建单独的侧边栏,例如“指南”页面和“配置参考”页面。 + +为此,首先将你的页面组织到每个所需部分的目录中: + +``` +. +├─ guide/ +│ ├─ index.md +│ ├─ one.md +│ └─ two.md +└─ config/ + ├─ index.md + ├─ three.md + └─ four.md +``` + +然后,更新配置以定义每个部分的侧边栏。你可以使用默认的方式传递一个对象, 对象的key必须是从vitepress根路径开始的绝对文件路径, 它必须以`/`做结尾, 这点和默认主题的sidebar多侧边栏配置相同, 不同的是对象的值, 除了可以传递一个数组之外, 还可以使用`"auto"`,这意味着主题会扫描这个路径下所有的`.md`文件, 并自动生成侧边栏. + +```js +export default { + themeConfig: { + sidebar: { + // 当用户位于 `guide` 目录时,会显示此侧边栏 + '/guide/': 'auto', + // 当用户位于 `config` 目录时,会显示此侧边栏 + '/config/': 'auto' + } + } +}; +``` diff --git a/packages/docs/guide/tag/frontmatter.md b/packages/docs/guide/tag/frontmatter.md deleted file mode 100644 index 4b9cab1..0000000 --- a/packages/docs/guide/tag/frontmatter.md +++ /dev/null @@ -1,3 +0,0 @@ -# frontmatter - -待补充 diff --git a/packages/docs/guide/tag/index.md b/packages/docs/guide/tag/index.md deleted file mode 100644 index 1e52c81..0000000 --- a/packages/docs/guide/tag/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar: - title: 标签布局 - ---- - -# 标签页 - -待补充 diff --git a/packages/docs/index.md b/packages/docs/index.md index 75dc4f5..c6079c4 100644 --- a/packages/docs/index.md +++ b/packages/docs/index.md @@ -24,10 +24,10 @@ hero: actions: - theme: brand text: 介绍 - link: /guide/introduction/ + link: /guide/intro/ - theme: brand text: 快速开始 - link: /guide/introduction/quick-start + link: /guide/intro/quick-start ---