水印
约 522 字
概述
主题内置的水印插件,为全站,或者单个页面添加水印。
关联插件:@vuepress/plugin-watermark
功能说明请参考 水印功能
使用
.vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
// watermark: true,
watermark: {
// enabled: false, // boolean 类型控制是否全局启用
enabled: page => true, // function 类型 过滤哪些页面启用水印
/**
* 是否全屏水印,默认为 `true`,
* 设置为 `false` 时,水印仅在 内容区域中显示。
*/
fullPage: true,
/** @see https://zhensherlock.github.io/watermark-js-plus/zh/config/ */
watermarkOptions: {
content: 'your watermark',
// ...
}
},
})
})关于配置入口的优先级说明,请参考 插件配置入口。
配置项
enabled
类型:
boolean | ((page: Page) => boolean)默认值:
true详情:
指定哪些页面需要添加水印。
拥有
true值的页面将会被添加水印。默认值
true与「未配置时不显示水印」并不冲突只有配置了
watermark(顶层watermark或plugins.watermark)时主题才会注册水印插件, 注册时会显式传入enabled: true。因此未配置watermark时全站都不会有水印, 这里的true描述的是「已配置水印时的默认行为」,它并不是启用开关。
fullPage
类型:
boolean默认值:
true详情:
是否为全屏水印。这是主题扩展字段,
@vuepress/plugin-watermark本身没有该选项。true:水印铺满整个页面false:水印仅在内容区域中显示
单个页面也可以通过在 frontmatter 中设置
watermark.fullPage: false覆盖。
watermarkOptions
类型:
WatermarkOptions默认值:
undefined详情: 配置项请参考 watermark-js-plus。
watermarkOptions.parent
类型:
string默认值:
body详情:添加水印的父元素选择器。
默认插入到 body 中,可以指定插入到页面的某个元素中。
Frontmatter
watermark
类型:
boolean | WatermarkOptions详情:
当类型为
boolean时,表示是否启用水印。当类型为
WatermarkOptions时,表示当前页面水印配置。可以参考 watermark-js-plus 。
frontmatter
---
watermark:
width: 200
height: 200
content: Your content
opacity: 0.5
---贡献者
更新日志
2026/10/13 15:56
查看所有更新日志
e4dae-docs: improve docs (#1071)于60619-docs: improve docs (#1069)于30739-docs: fix dead link (#935)于0daf2-docs: improve docs (#929)于aede6-fix(theme): twoslash comment error (#881)于4d236-feat(theme)!: add collections support (#704)于74dfa-docs: enable twoslash for code block于0fd6c-refactor(theme): improve types and flat config (#524)于0c53b-docs: improve docs (#332)于b079a-docs: update docs于
