vuepress-plugin-graypage
Version:
VuePress哀悼日网站变灰. | Mourning website turns gray plugin for VuePress.
95 lines (69 loc) • 3.86 kB
Markdown
# vuepress-plugin-graypage
[](https://www.npmjs.com/package/vuepress-plugin-graypage)
[](https://www.npmjs.com/package/vuepress-plugin-graypage)
[](https://www.npmjs.com/package/vuepress-plugin-graypage)
[](https://www.npmjs.com/package/vuepress-plugin-graypage)




[](https://zhousiwei.gitee.io "Author")
[](https://v1.vuepress.vuejs.org/zh/)
[](https://github.com/JoeyBling/vuepress-theme-yilia-plus)
[](https://jq.qq.com/?_wv=1027&k=58Ypj9z "博客搭建交流群")
------------------
> **欢迎使用和Star支持,如使用过程中碰到问题,可以提出 [Issues](https://github.com/JoeyBling/vuepress-plugin-graypage/issues),我会尽力完善**
## 介绍
    **VuePress哀悼日网站变灰. | Mourning website turns gray plugin for VuePress.**
> 此插件根据开源插件**[vuepress-plugin-graysite](https://github.com/zpfz/vuepress-plugin-graysite)**更改调整,加入了一些自定义参数配置.
- 功能还很少,欢迎各位给我提意见和建议~
## 线上预览
> **预览 ➡️ [https://zhousiwei.gitee.io/ibooks](https://zhousiwei.gitee.io/ibooks)**
## 推荐一款VuePress主题
> **一款简洁优雅的VuePress主题 ➡️ [https://github.com/JoeyBling/vuepress-theme-yilia-plus](https://github.com/JoeyBling/vuepress-theme-yilia-plus)**
## 效果截图

## 安装
```bash
yarn add vuepress-plugin-graypage
# or
npm install vuepress-plugin-graypage --save
```
------------
## 开始使用
### 引入该插件
在配置文件中引入 `vuepress-plugin-graypage`
> 查看 [官方文档](https://v1.vuepress.vuejs.org/zh/plugin/using-a-plugin.html)。
```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']
}
]
]
}
```
## 捐赠
    **如果感觉对您有帮助,请作者喝杯咖啡吧,请注明您的名字或者昵称,方便作者感谢o(* ̄︶ ̄*)o**
| 微信 | 支付宝 |
| :---: | :---: |
|  |  |
## LICENSE
[](./LICENSE "LICENSE")