docs: improve docs (#390)
This commit is contained in:
parent
fce7faf54b
commit
f0b2190fe4
@ -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
|
||||
}
|
||||
}),
|
||||
})
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
@ -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`
|
||||
|
||||
@ -77,7 +77,7 @@ npm install @iconify/json
|
||||
|
||||
## markdown 语法糖
|
||||
|
||||
相关内容请查看 [iconify-图标 语法糖](../markdown/进阶.md#iconify-图标)
|
||||
相关内容请查看 [iconify-图标 语法糖](../markdown/图标.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user