151 lines
3.3 KiB
Markdown
151 lines
3.3 KiB
Markdown
---
|
||
title: notes配置
|
||
author: pengzhanbo
|
||
createTime: 2024/03/02 14:00:06
|
||
permalink: /config/notes/
|
||
---
|
||
|
||
## 概述
|
||
|
||
主题默认将 `sourceDir` 目录下的 `notes` 目录作为 文档/知识笔记 的存放目录，
|
||
该目录下的所有文件都会被排除在 博客文章之外。
|
||
|
||
默认配置如下：
|
||
|
||
```ts
|
||
import { defineUserConfig } from 'vuepress'
|
||
import { plumeTheme } from 'vuepress-theme-plume'
|
||
|
||
export default defineUserConfig({
|
||
theme: plumeTheme({
|
||
notes: { link: '/', dir: 'notes', notes: [] }, // [!code highlight]
|
||
})
|
||
})
|
||
```
|
||
|
||
如果启用了 多语言配置， 你 也可以在 `locales` 字段中 分别配置 `notes`
|
||
|
||
```ts
|
||
import { defineUserConfig } from 'vuepress'
|
||
import { plumeTheme } from 'vuepress-theme-plume'
|
||
|
||
export default defineUserConfig({
|
||
theme: plumeTheme({
|
||
locales: {
|
||
'/': {
|
||
notes: { link: '/', dir: 'notes', notes: [] }, // [!code highlight]
|
||
},
|
||
'/zh/': {
|
||
notes: { link: '/zh/', dir: 'notes', notes: [] }, // [!code highlight]
|
||
}
|
||
}
|
||
})
|
||
})
|
||
```
|
||
|
||
## 配置
|
||
|
||
```ts
|
||
interface NotesDataOptions {
|
||
/**
|
||
* 保存所有笔记的目录
|
||
* @default '/notes'
|
||
*/
|
||
dir: string
|
||
/**
|
||
* 所有笔记的默认链接前缀
|
||
* @default '/'
|
||
*/
|
||
link: string
|
||
/**
|
||
* global include，只加载需要加载到笔记中的文件
|
||
*/
|
||
include?: string | string[]
|
||
/**
|
||
* global exclude，排除不需要加载到笔记中的文件
|
||
*/
|
||
exclude?: string | string[]
|
||
/**
|
||
* 笔记配置
|
||
*/
|
||
notes: NotesItemOptions[]
|
||
}
|
||
|
||
type NotesItemOptions = (Omit<NotesItem, 'text'> & { text?: string })
|
||
|
||
interface NotesItem {
|
||
/**
|
||
* 保存笔记的目录
|
||
*/
|
||
dir: string
|
||
/**
|
||
* 当前笔记的链接前缀，将会与 `notes.link` 合并
|
||
*/
|
||
link: string
|
||
/**
|
||
* 当前笔记名称
|
||
*/
|
||
text: string
|
||
/**
|
||
* 当前笔记的侧边栏配置,
|
||
* 如果设置为 `auto`，则自动根据目录结构生成侧边栏，根据 `\d+.xxx[.md]` 中 `\d+` 进行排序
|
||
*/
|
||
sidebar?: NotesSidebar | 'auto'
|
||
}
|
||
|
||
/**
|
||
* 可以将配置简写为文件名，主题会自动解析
|
||
*/
|
||
type NotesSidebar = (NotesSidebarItem | string)[]
|
||
|
||
interface NotesSidebarItem {
|
||
/**
|
||
* 侧边栏文本，如果为空，则使用 `dir`
|
||
*/
|
||
text?: string
|
||
/**
|
||
* 侧边栏链接
|
||
*/
|
||
link?: string
|
||
/**
|
||
* 次级侧边栏所在目录
|
||
*/
|
||
dir?: string
|
||
/**
|
||
* 是否折叠, 未定义时不可折叠
|
||
* @default undefined
|
||
*/
|
||
collapsed?: boolean
|
||
/**
|
||
* 次级侧边栏
|
||
*/
|
||
items?: NotesSidebar
|
||
/**
|
||
* - 支持 iconify 图标，直接使用 iconify name 即可自动加载
|
||
* @see https://icon-sets.iconify.design/
|
||
*
|
||
* - 如果 iconify 图标不满足您的需求，也可以支持传入 svg 字符串。
|
||
* - 还支持使用 本地图片 或 远程图片，本地图片的路径需要以 `/` 开头。
|
||
*/
|
||
icon?: string | { svg: string }
|
||
}
|
||
```
|
||
|
||
### 自动生成侧边栏
|
||
|
||
当配置某个 笔记 的 `sidebar` 为 `auto` 时，会自动根据目录结构生成侧边栏。
|
||
|
||
排序根据 [文件夹命名约定](/guide/write/#文件夹命名约定) 。
|
||
|
||
### 侧边栏图标
|
||
|
||
主题不仅可以通过 侧边栏配置中 `icon` 配置图标，还可以通过 文件中的 frontmatter 中 `icon` 字段 配置图标，
|
||
与 侧边栏配置中的 `icon` 一致。
|
||
|
||
```md
|
||
---
|
||
title: 主题介绍
|
||
icon: mdi:tooltip-text-outline
|
||
---
|
||
```
|