From bde63d9844098f98db46af47d5014888c312b302 Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Wed, 23 Oct 2024 17:05:47 +0800 Subject: [PATCH] docs: update docs --- docs/demos.md | 2 ++ docs/notes/theme/guide/功能/公告板.md | 7 ++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/demos.md b/docs/demos.md index 366e1026..cc453b5d 100644 --- a/docs/demos.md +++ b/docs/demos.md @@ -44,6 +44,8 @@ blog: 你可以随时通过 [PR](https://github.com/pengzhanbo/vuepress-theme-plume/edit/main/docs/demos.md) 添加你的 文档 或 博客 到这个页面。 站点预览图片请放到 `docs/.vuepress/public/images/demos` 目录下。推荐使用远程链接,以便可以随时更新它。 + +图片请尽量使用 `.jpg` 格式,体积较大的请使用 [tinypng](https://tinypng.com/) 进行压缩。 ::: ## 文档 diff --git a/docs/notes/theme/guide/功能/公告板.md b/docs/notes/theme/guide/功能/公告板.md index ad468e9e..0a93fdaf 100644 --- a/docs/notes/theme/guide/功能/公告板.md +++ b/docs/notes/theme/guide/功能/公告板.md @@ -1,6 +1,9 @@ --- title: 公告板 icon: mingcute:announcement-line +badge: + type: tip + text: v1.0.0-rc.112 + createTime: 2024/10/19 21:51:22 permalink: /guide/features/bulletin/ --- @@ -57,7 +60,7 @@ interface BulletinOptions { /** * 公告持续时间 * - * @default 'session' + * @default 'always' * * - `'session'` 表示在会话周期内关闭公告后不再显示,在新的会话周期重新显示,刷新页面不会重新显示 * - `'always'` 表示总是显示,关闭公告后刷新页面会重新显示 @@ -310,6 +313,8 @@ export default defineClientConfig({ 您可以直接在 `Bulletin.vue` 组件中使用它。 ```ts +import { useBulletinControl } from 'vuepress-theme-plume/composables' + const { bulletin, // 公告板配置, 从主题配置中读取 showBulletin, // 是否显示公告板