From e35e3d99ef3bca8d9b2da681f9f86029d4e018fa Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Tue, 16 Jul 2024 00:17:38 +0800 Subject: [PATCH] docs: update docs --- docs/notes/theme/guide/api-node.md | 6 +++++ docs/notes/theme/guide/布局插槽.md | 35 ++++++++++++++++++++---------- 2 files changed, 29 insertions(+), 12 deletions(-) diff --git a/docs/notes/theme/guide/api-node.md b/docs/notes/theme/guide/api-node.md index d7df6f4c..f9ef325c 100644 --- a/docs/notes/theme/guide/api-node.md +++ b/docs/notes/theme/guide/api-node.md @@ -20,6 +20,12 @@ __options__ : `PlumeThemeOptions` 查看 [主题配置](/config/basic/) 了解更多。 +## `defineThemeConfig(options)` + +主题配置帮助函数,用于在单独的 `plume.config.ts` 中使用。 + +查看 [主题配置文件](../config/配置说明.md#主题配置文件) 了解更多。 + ## `defineNavbarConfig(options)` 主题导航栏配置函数。 diff --git a/docs/notes/theme/guide/布局插槽.md b/docs/notes/theme/guide/布局插槽.md index 10add777..1d562bc9 100644 --- a/docs/notes/theme/guide/布局插槽.md +++ b/docs/notes/theme/guide/布局插槽.md @@ -8,12 +8,12 @@ permalink: /guide/layout-slots/ ## 概述 -主题通过 `` 提供了 丰富的 布局插槽,可以通过这些插槽,在 页面 的不同位置注入内容。 +主题通过 `` 和 `` 提供了 丰富的 布局插槽,可以通过这些插槽,在 页面 的不同位置注入内容。 以便用户可以个性化的使用主题。 ## 使用 -首先,需要创建一个 客户端配置文件: `.vuepress/client.ts`: +以 `` 为例,首先,需要创建一个 客户端配置文件: `.vuepress/client.ts`: ```ts import { defineClientConfig } from 'vuepress/client' @@ -69,7 +69,7 @@ export default defineClientConfig({ ## 插槽 -主题支持以下插槽: +### `` 插槽 - 当 `pageLayout: doc` 时: @@ -115,13 +115,24 @@ export default defineClientConfig({ - `blog-archives-before` - `blog-archives-after` -- 总是启用: +- 在 博客分类页 中: - - `layout-top` - - `layout-bottom` - - `nav-bar-title-before` - - `nav-bar-title-after` - - `nav-bar-content-before` - - `nav-bar-content-after` - - `nav-screen-content-before` - - `nav-screen-content-after` + - `blog-categories-before` + - `blog-categories-after` + +### `` 插槽 + +- `not-found` + +### 通用插槽 + +以下插槽在 `` 和 `` 中都支持: + +- `layout-top` +- `layout-bottom` +- `nav-bar-title-before` +- `nav-bar-title-after` +- `nav-bar-content-before` +- `nav-bar-content-after` +- `nav-screen-content-before` +- `nav-screen-content-after`