Skip to content

Commit

Permalink
Merge pull request #3 from ruibaby/docs/update-readme
Browse files Browse the repository at this point in the history
docs: update readme
  • Loading branch information
n0vad3v authored Jul 3, 2023
2 parents 3ef715b + d223d18 commit c01a522
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# WebP Cloud Halo plugin

The Halo plugin for WebP Cloud(https://webp.se).
此插件提供对 WebP Cloud(<https://webp.se>)的集成,支持在文章页面无入侵式的自动替换图片为 WebP 格式。

## 使用

### [WebP Cloud Dashboard](https://dashboard.webp.se/proxy) 创建一个代理(Proxy)

![Create a Proxy](./images/dashboard.webp.create_proxy.png)

创建完成之后,就可以看到你的 `Proxy Address` 了:

![Demo Proxy](./images/dashboard.webp.proxy.png)

## 下载并安装此插件

进入 [Releases](https://github.com/webp-sh/halo-plugin-webp-cloud/releases) 页面,选择最新版本下载 Assets 中的 `plugin-webp-cloud-xxx.jar` 文件即可。

安装插件的方式可以参考官方文档:<https://docs.halo.run/user-guide/plugins#%E5%AE%89%E8%A3%85%E6%8F%92%E4%BB%B6>

## 配置插件

安装完成之后,进入插件详情页面中的基础设置选项卡,填入你的 `Proxy Address`,保存即可。

![Plugin Setting](./images/plugin-webp-se-cloud-setting.png)

最后,进入任意一篇包含图片的文章,检查一下浏览器的 Network 面板,就可以看到图片的源地址已经修改为了你设置的 `Proxy Address` 了。
Binary file added images/dashboard.webp.create_proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard.webp.proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/plugin-webp-se-cloud-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c01a522

Please sign in to comment.