项目简介
本项目是用于VuePress的插件,能使网站在特定日期(如哀悼日)自动变为灰色调。该插件基于开源插件 vuepress-plugin-graysite
更改调整,添加了自定义参数配置。
项目的主要特性和功能
- 可配置日期变灰:支持通过配置月 + 日、年 + 月 + 日指定哀悼日生效日期,也能设置特殊日期(如清明节)让网站变灰。
- 日志打印:可选择是否开启控制台日志打印,便于调试和了解插件运行状态。
安装使用步骤
安装
假设已下载本项目的源码文件,在项目根目录下,通过以下命令安装插件:
bash
yarn add vuepress-plugin-graypage
npm install vuepress-plugin-graypage --save
使用
引入插件
在VuePress的配置文件中引入该插件:
javascript
module.exports = {
plugins: [
'vuepress-plugin-graypage',
],
}
插件配置
如需自定义配置,可按如下方式设置:
javascript
module.exports = {
plugins: [
[
'vuepress-plugin-graypage', {
// 是否开启控制台日志打印(default: false)
log: true,
// 月+日(哀悼日生效日期)
mournDay: ['4-4'],
// 年+月+日(哀悼日生效日期)
date: ['2020-8-27'],
// 特殊的日期(例如:清明节等...建议使用默认即可)
special: ['qinMing']
}
]
]
}
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】