diff --git a/docs/.vuepress/notes.ts b/docs/.vuepress/notes.ts index 43875e22..5f9b2da6 100644 --- a/docs/.vuepress/notes.ts +++ b/docs/.vuepress/notes.ts @@ -1,6 +1,6 @@ -import { definePlumeNotesConfig } from 'vuepress-theme-plume' +import { defineNotesConfig } from 'vuepress-theme-plume' -export const zhNotes = definePlumeNotesConfig({ +export const zhNotes = defineNotesConfig({ dir: 'notes', link: '/', notes: [ @@ -61,12 +61,14 @@ export const zhNotes = definePlumeNotesConfig({ icon: 'lucide:box', collapsed: false, prefix: '功能', - items: ['图标', '代码复制', '内容搜索', '评论', '加密', '组件', '文章水印', '友情链接页', 'seo', 'sitemap', { - text: '非内置功能', - icon: 'system-uicons:box-add', - collapsed: true, - items: ['repoCard', 'npmBadge'], - }], + items: ['图标', '代码复制', '内容搜索', '评论', '加密', '文章水印', '友情链接页', 'seo', 'sitemap'], + }, + { + text: '组件', + prefix: '组件', + icon: 'uiw:component', + collapsed: false, + items: ['徽章', '图标', '隐秘文本', '卡片', '链接卡片', '图片卡片', '卡片容器', '首页布局容器', 'repoCard', 'npmBadge'], }, { text: '自定义', @@ -155,7 +157,7 @@ export const zhNotes = definePlumeNotesConfig({ ], }) -export const enNotes = definePlumeNotesConfig({ +export const enNotes = defineNotesConfig({ dir: 'en/notes', link: '/', notes: [], diff --git a/docs/1.示例/markdown扩展.md b/docs/1.示例/markdown扩展.md index b41c8fa8..d77631f9 100644 --- a/docs/1.示例/markdown扩展.md +++ b/docs/1.示例/markdown扩展.md @@ -27,20 +27,28 @@ tags: 内部和外部链接都会被特殊处理。 主题默认对每个 md 文件自动生成一个新的 链接，并保存在对应的 md 文件的 frontmatter 的 `permalink` 中。 -你可以随时修改它们。 +你可以随时修改它们。你也可以通过 `theme.autoFrontmatter` 选项来禁用这个功能，这时会恢复为 VuePress 的默认行为。 ### 内部链接 -建议使用 生成的 `permalink` 作为内部链接的目标。 +有三种方式来使用内部链接： + +- 使用 生成的 `permalink` 作为内部链接的目标。 +- 使用 md 文件的相对路径作为内部链接的目标。 +- 使用 md 文件的绝对路径作为内部链接的目标， 绝对路径 `/` 表示从 `${sourceDir}` 目录开始。 ```md [Markdown](/guide/markdown/) + +[Markdown](./markdown基础.md) ``` 渲染为： [Markdown](/guide/markdown/) +[Markdown](./markdown基础.md) + #### 外部链接 外部链接带有 `target="_blank" rel="noreferrer"` ： diff --git a/docs/notes/plugins/netlify-functions/介绍.md b/docs/notes/plugins/netlify-functions/介绍.md index ad21749e..c3bde97d 100644 --- a/docs/notes/plugins/netlify-functions/介绍.md +++ b/docs/notes/plugins/netlify-functions/介绍.md @@ -58,4 +58,4 @@ permalink: /plugins/plugin-netlify-functions/introduction/ 并且将 所有 functions 添加在 vuepress 的构建包中。 -如何使用插件，请查看 [使用文档](/plugins/plugin-netlify-functions/usage/) +如何使用插件，请查看 [使用文档](./使用.md) diff --git a/docs/notes/theme/config/frontmatter/home.md b/docs/notes/theme/config/frontmatter/home.md index d2447537..26528b1a 100644 --- a/docs/notes/theme/config/frontmatter/home.md +++ b/docs/notes/theme/config/frontmatter/home.md @@ -66,4 +66,4 @@ interface PlumeHomeConfigBase { } ``` -更多详细配置请参考 [自定义首页](/guide/custom-home/) +更多详细配置请参考 [自定义首页](../../guide/自定义首页.md) diff --git a/docs/notes/theme/config/plugins/markdownPower.md b/docs/notes/theme/config/plugins/markdownPower.md index 91000c87..940f372c 100644 --- a/docs/notes/theme/config/plugins/markdownPower.md +++ b/docs/notes/theme/config/plugins/markdownPower.md @@ -40,4 +40,4 @@ export default defineUserConfig({ ## 配置 -查看 [文档](/plugins/plugin-md-power/) +查看 [文档](../../../plugins/md-power.md) diff --git a/docs/notes/theme/config/主题配置.md b/docs/notes/theme/config/主题配置.md index dad53156..5de80ccf 100644 --- a/docs/notes/theme/config/主题配置.md +++ b/docs/notes/theme/config/主题配置.md @@ -26,7 +26,7 @@ permalink: /config/basic/ 对主题内部使用的插件进行自定义配置。 主题使用的插件默认已进行了配置，大多数情况下您不需要进行修改，如果需要使用到细致的定制化，请查阅 -[此文档](/config/plugins/) +[此文档](./plugins/README.md) ::: warning 该字段不支持在 [主题配置文件 `plume.config.js`](./配置说明.md#主题配置文件) 中进行配置。 @@ -189,7 +189,7 @@ interface BlogOptions { - 默认值： `{}` - 详情： 多语言配置 -多语言配置，参考 [此文档](/config/locales/) +多语言配置，参考 [此文档](./多语言配置.md) 多语言配置支持以下 [Locale](#locale-配置) 所有配置选项 diff --git a/docs/notes/theme/guide/markdown/扩展.md b/docs/notes/theme/guide/markdown/扩展.md index ff92f4a2..be180df7 100644 --- a/docs/notes/theme/guide/markdown/扩展.md +++ b/docs/notes/theme/guide/markdown/扩展.md @@ -28,20 +28,28 @@ tags: 内部和外部链接都会被特殊处理。 主题默认对每个 md 文件自动生成一个新的 链接，并保存在对应的 md 文件的 frontmatter 的 `permalink` 中。 -你可以随时修改它们。 +你可以随时修改它们。你也可以通过 `theme.autoFrontmatter` 选项来禁用这个功能，这时会恢复为 VuePress 的默认行为。 ### 内部链接 -建议使用 生成的 `permalink` 作为内部链接的目标。 +有三种方式来使用内部链接： + +- 使用 生成的 `permalink` 作为内部链接的目标。 +- 使用 md 文件的相对路径作为内部链接的目标。 +- 使用 md 文件的绝对路径作为内部链接的目标， 绝对路径 `/` 表示从 `${sourceDir}` 目录开始。 ```md [Markdown](/guide/markdown/) + +[Markdown](./基础.md) ``` 渲染为： [Markdown](/guide/markdown/) +[Markdown](./基础.md) + ### 外部链接 外部链接带有 `target="_blank" rel="noreferrer"` ： diff --git a/docs/notes/theme/guide/markdown/进阶.md b/docs/notes/theme/guide/markdown/进阶.md index d0649d64..766bacc1 100644 --- a/docs/notes/theme/guide/markdown/进阶.md +++ b/docs/notes/theme/guide/markdown/进阶.md @@ -580,7 +580,7 @@ export default defineUserConfig({ @[caniuse](feature) ``` -为了方便使用，主题提供了工具支持：[caniuse 特性搜索](/tools/caniuse/)，你可以直接使用该工具 +为了方便使用，主题提供了工具支持：[caniuse 特性搜索](../../../tools/caniuse.md)，你可以直接使用该工具 帮助生成 markdown 代码。 ### 语法 diff --git a/docs/notes/theme/guide/代码/介绍.md b/docs/notes/theme/guide/代码/介绍.md index c636451b..678b4a87 100644 --- a/docs/notes/theme/guide/代码/介绍.md +++ b/docs/notes/theme/guide/代码/介绍.md @@ -86,11 +86,11 @@ export default defineUserConfig({ ## 更多支持 得益于 [Shiki](https://shiki.style/) 的强大能力，Theme Plume 还为 代码块 -提供了 更多的 [特性支持](/guide/code/features/)，它们让 代码块具备更强的表达能力。 +提供了 更多的 [特性支持](./特性支持.md)，它们让 代码块具备更强的表达能力。 -同时，为了方便 更好的 完成 代码演示，Theme Plume 还提供了嵌入 [CodePen](/guide/code/code-pen/)， -[Js Fiddle](/guide/code/jsfiddle/)，[Code Sandbox](/guide/code/code-sandbox/)， -[Replit](/guide/code/replit/) 的语法支持，你可以很方便的嵌入代码演示。 +同时，为了方便 更好的 完成 代码演示，Theme Plume 还提供了嵌入 [CodePen](../代码演示/codepen.md)， +[Js Fiddle](../代码演示/jsFiddle.md)，[Code Sandbox](../代码演示/codeSandbox.md)， +[Replit](../代码演示/replit.md) 的语法支持，你可以很方便的嵌入代码演示。 ## 示例 diff --git a/docs/notes/theme/guide/功能/友情链接页.md b/docs/notes/theme/guide/功能/友情链接页.md index 4dd1839b..9f157034 100644 --- a/docs/notes/theme/guide/功能/友情链接页.md +++ b/docs/notes/theme/guide/功能/友情链接页.md @@ -44,4 +44,4 @@ list: ### 配置 -查看 [文档](/config/frontmatter/friends/) 更多配置信息。 +查看 [文档](../../config/frontmatter/friend.md) 更多配置信息。 diff --git a/docs/notes/theme/guide/功能/组件.md b/docs/notes/theme/guide/功能/组件.md index b920b32e..c1070f17 100644 --- a/docs/notes/theme/guide/功能/组件.md +++ b/docs/notes/theme/guide/功能/组件.md @@ -326,16 +326,3 @@ export default defineUserConfig({ - -## 首页布局容器 - -自定义首页时，使用 ``提供给 区域 的 包装容器。 - -### Props - -| 名称 | 类型 | 默认值 | 说明 | -| --------------------- | ------------------ | --------- | ---------------- | -| type | string | `''` | 区域类型 | -| full | boolean | `false` | 是否全屏 | -| background-image | string | `''` | 区域背景图片 | -| background-attachment | `'fixed'\|'local'` | `'local'` | 区域背景定位方式 | diff --git a/docs/notes/theme/guide/知识笔记.md b/docs/notes/theme/guide/知识笔记.md index de15025e..1c845026 100644 --- a/docs/notes/theme/guide/知识笔记.md +++ b/docs/notes/theme/guide/知识笔记.md @@ -78,4 +78,4 @@ export default defineUserConfig({ ::: -完整配置查看 [notes配置](/config/notes/) +完整配置查看 [notes配置](../config/notes配置.md) diff --git a/docs/notes/theme/guide/功能/npmBadge.md b/docs/notes/theme/guide/组件/npmBadge.md similarity index 99% rename from docs/notes/theme/guide/功能/npmBadge.md rename to docs/notes/theme/guide/组件/npmBadge.md index e3640aae..77c51269 100644 --- a/docs/notes/theme/guide/功能/npmBadge.md +++ b/docs/notes/theme/guide/组件/npmBadge.md @@ -3,7 +3,7 @@ title: Npm 徽章 author: pengzhanbo icon: akar-icons:npm-fill createTime: 2024/07/26 22:07:23 -permalink: /guide/npm-badge/ +permalink: /guide/components/npm-badge/ ---