Skip to content

Commit

Permalink
docs: 增加关于水印功能的文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Mereithhh committed Feb 27, 2023
1 parent 8517c74 commit 2fb2da4
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
- [x] 支持自定义页面。
- [x] 可添加具有指定权限的协作者。
- [x] 内置图床,并支持各种 OSS 图床、github 图床(外部图床基于 picgo)等。
- [x] 支持上传图片自动添加水印,无论何种图床
- [x] 极致轻量化,没有花里胡哨。页面秒切换、图片懒加载。
- [x] 脚本一键部署,多种部署方式,支持 ARM 平台。
- [x] 支持 GA、百度分析
Expand Down Expand Up @@ -166,6 +167,7 @@ curl -L https://vanblog.mereith.com/vanblog.sh -o vanblog.sh && chmod +x vanblog
- [x] 分类加密
- [ ] 快捷分享按钮
- [x] 完善可自定义上传文件的自定义页面功能(现在的自定义页面有潜在的 css 污染问题)
- [x] 图片上传自动添加水印
- [ ] 增加在特定事件后触发执行自定义代码或 webhook 的扩展能力
- [ ] 插件系统
- [ ] 自定义主题(前端渲染器)系统
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ features:

- title: 内置图床
icon: pic
details: 本地图床,OSS 图床,Github 图床都支持,可一键上传剪切板图片
details: 本地图床,OSS 图床,Github 图床都支持,可一键上传剪切板图片,自动添加水印

- title: 高性能
icon: light
Expand Down
18 changes: 18 additions & 0 deletions docs/feature/basic/pic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@
title: 图床
---

## 自动水印

无论使用何种图床,`vanblog` 都支持上传图片自动添加水印。在后台 `站点管理/系统设置/图床设置` 中,开启水印并输入水印文字即可。

![](https://pic.mereith.com/img/9a49bf9afa30c136994330014ca9d2d9.clipboard-2023-02-27.png)

- 后台中但凡表单中有上传按钮的选项,不走水印逻辑。
- 编辑器上传图片,和图片管理中的上传会走这个逻辑,和用的图床种类无关。
- `vanblog` 会在收到图片信息的时候,先进行水印转换,再保存到对应图床。

### 限制

- 由于使用了 [jimp](https://github.com/jimp-dev/jimp/) 库做水印,字体用了 `fnt` 格式,所以暂不支持中文字符作为水印。
- 水印会加到图片右下角,带透明度的灰色字体。
- [ ] 后续会增加使用自定义图片做水印的
- 水印目前只支持上传 `png``jpg` 等常见格式,暂不支持动图。
- 如果谁有更好的 `nodejs` 水印方案,请提 `issue` 或者直接联系我。

## 自带图床

你可以选择 `vanBlog` 内置的图床实现,无需任何配置,开箱即用。但是请记得在部署时映射好目录以防更新后丢失数据。
Expand Down
2 changes: 2 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持 HTTPS
- [x] 支持自定义页面。
- [x] 可添加具有指定权限的协作者。
- [x] 内置图床,并支持各种 OSS 图床、github 图床(外部图床基于 picgo)等。
- [x] 支持上传图片自动添加水印,无论何种图床
- [x] 极致轻量化,没有花里胡哨。页面秒切换、图片懒加载。
- [x] 脚本一键部署,多种部署方式,支持 ARM 平台。
- [x] 支持 GA、百度分析
Expand Down Expand Up @@ -103,6 +104,7 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持 HTTPS
- [x] 分类加密
- [ ] 快捷分享按钮
- [x] 完善可自定义上传文件的自定义页面功能(现在的自定义页面有潜在的 css 污染问题)
- [x] 图片上传自动添加水印
- [ ] 增加在特定事件后触发执行自定义代码或 webhook 的扩展能力
- [ ] 插件系统
- [ ] 自定义主题(前端渲染器)系统
Expand Down

0 comments on commit 2fb2da4

Please sign in to comment.