docs: update docs

This commit is contained in:
pengzhanbo 2024-08-18 10:33:54 +08:00
parent 4c5b952af2
commit 27fdc6943b
3 changed files with 19 additions and 9 deletions

View File

@ -46,7 +46,7 @@ export default defineUserConfig({
## 配置
```ts
interface NotesDataOptions {
interface NotesOptions {
/**
* 保存所有笔记的目录
* @default '/notes/'
@ -63,7 +63,7 @@ interface NotesDataOptions {
notes: NoteItem[]
}
interface NotesItem {
interface NoteItem {
/**
* 保存笔记的目录
*/

View File

@ -422,7 +422,7 @@ type NavItem = string | {
### notes
- 类型: `false | PlumeThemeNotesOptions`
- 类型: `false | NotesOptions`
- 默认值: `{ link: '/note', dir: 'notes', notes: [] }`
- 详情:

View File

@ -18,7 +18,7 @@ __options__ : `PlumeThemeOptions`
主题配置函数。
查看 [主题配置](/config/basic/) 了解更多。
查看 [主题配置](../config/主题配置.md) 了解更多。
## `defineThemeConfig(options)`
@ -28,12 +28,22 @@ __options__ : `PlumeThemeOptions`
## `defineNavbarConfig(options)`
主题导航栏配置函数。
主题导航栏配置类型帮助函数。
查看 [主题配置](/config/navigation/) 了解更多。
查看 [主题配置](../config/导航栏配置.md) 了解更多。
## `definePlumeNotesConfig(options)`
## `defineNotesConfig(options)`
主题 notes 配置函数
__options:__ `NotesOptions`
查看 [主题配置](/config/notes/) 了解更多。
主题 notes 配置类型帮助函数
查看 [主题配置](../config/notes配置.md) 了解更多。
## `defineNoteConfig(options)`
__options:__ `NoteItem`
主题 单个 note (`NoteItem`) 配置类型帮助函数
查看 [主题配置](../config/notes配置.md) 了解更多。