watermark

将 watermark-js-plus 到 VuePress 中。

此插件可在在页面中添加水印，可以选择为 全局页面 或 部分页面添加水印，还可以选择添加 文字水印 或 图片水印。

使用

npm i -D @vuepress/plugin-watermark@next

import { watermarkPlugin } from '@vuepress/plugin-watermark'

export default {
  plugins: [
    watermarkPlugin({
      // options
    }),
  ],
}

配置项

enabled

• 类型： boolean | ((page: Page) => boolean)

• 默认值： false

• 详情：

  指定哪些页面需要添加水印。

  拥有 true 值的页面将会被添加水印。

watermarkOptions

• 类型： WatermarkOptions

• 默认值： undefined

• 详情： 配置项请参考 watermark-js-plus。

watermarkOptions.parent

• 类型： string

• 默认值： body

• 详情：添加水印的父元素选择器。

  默认插入到 body 中，可以指定插入到页面的某个元素中。

delay

• 类型： number

• 默认值： 500

• 详情：添加水印的延时。以毫秒为单位。

  延迟时间取决于页面过渡动画时间，可以根据实际情况调整。

  如果水印的父元素在切换页面时被重新渲染，那么延迟时间应该比页面过渡时间长一些。

Frontmatter

watermark

• 类型: boolean | WatermarkOptions

• 详情：

  当类型为 boolean 时，表示是否启用水印。

  当类型为 WatermarkOptions 时，表示当前页面水印配置。

  可以参考 watermark-js-plus 。

---
watermark:
  width: 200
  height: 200
  content: Your content
  opacity: 0.5
---

客户端配置

defineWatermarkConfig(config)

• 类型： (config: MaybeRefOrGetter<WatermarkOptions>) => void

传递给 watermark-js-plus 的额外配置。

import { defineWatermarkConfig } from '@vuepress/plugin-watermark/client'

defineWatermarkConfig({
  // 在此设置额外的 watermark 配置
})

通常来说，大部分选项应该在 Node 中定义，但存在一些特殊情况。
比如需要在 深色/浅色 模式 下控制不同的 水印 透明度、字体颜色等，
或者需要传入如 onSuccess、extraDrawFunc 等回调函数。

import { computed } from 'vue'

export default defineClientConfig({
  setup() {
    const isDark = useDarkMode()

    const watermarkConfig = computed(() => ({
      fontColor: isDark.value ? '#fff' : '#000',
      onSuccess: () => {
        console.log('success')
      },
    }))

    defineWatermarkConfig(watermarkConfig)
  },
})