docs: update docs

This commit is contained in:
pengzhanbo 2024-06-18 14:39:06 +08:00
parent 9e19de62bb
commit 28ae80e284
2 changed files with 26 additions and 10 deletions

View File

@ -334,6 +334,20 @@ type NavItem = string | {
详细配置请查看 [此文档](/config/notes/)
### aside
- 类型: `boolean | 'left'`
- 默认值: `true`
- 详情:
是否显示侧边栏
- `false` 表示禁用 右侧边栏
- `true` 表示启用 右侧边栏
- `'left` 表示将有侧边栏移动到文章内容左侧sidebar 右侧
每个页面可以通过 [frontmatter aside](./frontmatter/basic.md#aside) 覆盖层级配置。
### outline
- 类型: `false | number | [number, number] | 'deep'`
@ -348,6 +362,8 @@ type NavItem = string | {
`'deep'``[2, 6]` 相同,将显示从 `<h2>``<h6>` 的所有标题。
当 [aside](#aside) 被禁用时,`outline` 也会被禁用
每个页面可以通过 [frontmatter outline](./frontmatter/basic.md#outline) 覆盖层级配置。
### selectLanguageName
@ -366,7 +382,7 @@ type NavItem = string | {
- 默认值: `''`
- 详情:
_选择语言菜单_ 的文
_选择语言菜单_ 的文
如果你在站点配置中设置了多个 [locales](#locales) ,那么 _选择语言菜单_ 就会显示在导航栏中仓库按钮的旁边。
@ -386,7 +402,7 @@ type NavItem = string | {
- 默认值: `'Menu'`
- 详情:
移动设备下的导航栏中 菜单选项的文
移动设备下的导航栏中 菜单选项的文
### returnToTopLabel
@ -394,7 +410,7 @@ type NavItem = string | {
- 默认值: `'return to top'`
- 详情:
移动设备下的导航栏中返回顶部的文
移动设备下的导航栏中返回顶部的文
### outlineLabel
@ -402,7 +418,7 @@ type NavItem = string | {
- 默认值: `'On this page'`
- 详情:
移动设备下的导航栏中大纲标题的文
移动设备下的导航栏中大纲标题的文
### editLink
@ -414,7 +430,7 @@ type NavItem = string | {
- 类型: `string`
- 默认值: `'Edit this page'`
- 详情: 编辑链接文
- 详情: 编辑链接文
### editLinkPattern
@ -428,7 +444,7 @@ type NavItem = string | {
- 类型: `string`
- 默认值: `''`
- 详情: 文档仓库配置, 用于生成 `Edit this page` 链接,如果为空,默认使用 `repo` 配置的值
- 详情: 文档仓库配置, 用于生成 `Edit this page` 链接
### docsBranch
@ -478,19 +494,19 @@ interface LastUpdatedOptions {
- 类型: `string`
- 默认值: `'Contributors'`
- 详情: 贡献者的文
- 详情: 贡献者的文
### prevPageLabel
- 类型: `string`
- 默认值: `'Previous Page'`
- 详情: 上一页的文
- 详情: 上一页的文
### nextPageLabel
- 类型: `string`
- 默认值: `'Next Page'`
- 详情: 下一页的文
- 详情: 下一页的文
### notFound

View File

@ -112,7 +112,7 @@ home: true
config:
-
type: banner
banner: https://file.mo7.cc/api/public/bz
banner: https://api.pengzhanbo.cn/wallpaper/bing
bannerMask:
light: 0.1
dark: 0.3