From f0b2190fe48c9affa3c0e3bfb26aa703178af327 Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Fri, 20 Dec 2024 14:47:32 +0800 Subject: [PATCH] docs: improve docs (#390) --- docs/notes/theme/config/plugins/阅读统计.md | 26 ++++++++++++++++++++- docs/notes/theme/config/主题配置.md | 6 +++++ docs/notes/theme/guide/功能/图标.md | 2 +- 3 files changed, 32 insertions(+), 2 deletions(-) diff --git a/docs/notes/theme/config/plugins/阅读统计.md b/docs/notes/theme/config/plugins/阅读统计.md index 6555eab3..029c91d9 100644 --- a/docs/notes/theme/config/plugins/阅读统计.md +++ b/docs/notes/theme/config/plugins/阅读统计.md @@ -24,7 +24,7 @@ export default defineUserConfig({ plugins: { readingTime: { wordPerMinute: 300 - } + }, } }), }) @@ -69,3 +69,27 @@ interface ReadingTimePluginLocaleConfig { [localePath: string]: ReadingTimePluginLocaleData } ``` + +## 禁用 + +可以通过配置 `plugins.readingTime` 为 `false` 禁用该插件。 + +禁用后,文章页不会显示字数统计与预计阅读时间。 + +::: code-tabs +@tab .vuepress/config.ts + +```ts +import { defineUserConfig } from 'vuepress' +import { plumeTheme } from 'vuepress-theme-plume' + +export default defineUserConfig({ + theme: plumeTheme({ + plugins: { + readingTime: false + } + }), +}) +``` + +::: diff --git a/docs/notes/theme/config/主题配置.md b/docs/notes/theme/config/主题配置.md index 8e99d288..e477a56d 100644 --- a/docs/notes/theme/config/主题配置.md +++ b/docs/notes/theme/config/主题配置.md @@ -51,6 +51,9 @@ permalink: /config/basic/ 博客配置。 + ::: warning 该字段不支持在 [主题配置文件 `plume.config.js`](./配置说明.md#主题配置文件) 中进行配置。 + ::: + ```ts interface BlogOptions { /** @@ -200,6 +203,9 @@ interface BlogPostCover { - 默认值: `/article/` - 详情: 文章链接前缀 + ::: warning 该字段不支持在 [主题配置文件 `plume.config.js`](./配置说明.md#主题配置文件) 中进行配置。 + ::: + ### autoFrontmatter - 类型: `false | AutoFrontmatterOptions` diff --git a/docs/notes/theme/guide/功能/图标.md b/docs/notes/theme/guide/功能/图标.md index d1ae8048..845c9b6c 100644 --- a/docs/notes/theme/guide/功能/图标.md +++ b/docs/notes/theme/guide/功能/图标.md @@ -77,7 +77,7 @@ npm install @iconify/json ## markdown 语法糖 -相关内容请查看 [iconify-图标 语法糖](../markdown/进阶.md#iconify-图标) +相关内容请查看 [iconify-图标 语法糖](../markdown/图标.md) ---