Waline 是一款基于 Valine 衍生的简洁、安全的评论系统。本文记录 fluid 主题安装Waline 方法。
简介
Waline 是一款基于 Valine 衍生的简洁、安全的评论系统。
- 官网链接:https://waline.js.org/
- 相对于 Valine 有一些后天的优势:
优势 | 描述 |
---|---|
自由评论 | 完全的 Markdown 支持,同时包含表情、数学公式、HTML 嵌入 |
轻量 | 54kB gzip 的完整客户端大小 |
强大的安全性 | 内容校验、防灌水、保护敏感数据等 |
登录支持 | 在允许匿名评论的基础上,支持账号注册,保持身份 |
完全免费部署 | 可免费部署在 Vercel 上 |
易于部署 | 多种部署部署方式和存储服务支持 |
使用方法
LeanCloud 设置 (数据库)
- 登录在新窗口打开 或 注册在新窗口打开
LeanCloud 国际版
并进入 控制台在新窗口打开 - 点击左下角 创建应用在新窗口打开 并起一个你喜欢的名字 (请选择免费的开发版):
- 进入应用,选择左下角的
设置
>应用 Key
。你可以看到你的APP ID
,APP Key
和Master Key
。后续我们会用到这三个值。
注意: 如果你正在使用 Leancloud 国内版 (leancloud.cn在新窗口打开),我们推荐你切换到国际版 (leancloud.app在新窗口打开)。否则,你需要为应用额外绑定已备案的域名:
- 登录国内版并进入需要使用的应用
- 选择
设置
>域名绑定
>API 访问域名
>绑定新域名
> 输入域名 >确定
。 - 按照页面上的提示按要求在 DNS 上完成 CNAME 解析。
Vercel 部署 (服务端)
- 点击上方按钮,跳转至 Vercel 进行 Server 端部署。
- 如果你未登录的话,Vercel 会让你注册或登录,请使用 GitHub 账户进行快捷登录。
- 输入一个你喜欢的 Vercel 项目名称并点击
Create
继续:
- 此时会让你创建 Team 账号,这里选择
Skip
即可:
- 此时 Vercel 会基于 Waline 模板帮助你新建并初始化仓库,仓库名为你之前输入的项目名。
一两分钟后,满屏的烟花会庆祝你部署成功。此时点击 Go to Dashboard
可以跳转到应用的控制台。
- 点击顶部的
Settings
-Environment Variables
进入环境变量配置页,并配置三个环境变量LEAN_ID
,LEAN_KEY
和LEAN_MASTER_KEY
。它们的值分别对应上一步在 LeanCloud 中获得的APP ID
,APP KEY
,Master Key
。
提示:如果你使用 LeanCloud 国内版,请额外配置
LEAN_SERVER
环境变量,值为你绑定好的域名。
- 环境变量配置完成之后点击顶部的
Deployments
点击顶部最新的一次部署右侧的Redeploy
按钮进行重新部署。该步骤是为了让刚才设置的环境变量生效。
- 此时会跳转到
Overview
界面开始部署,等待片刻后STATUS
会变成Ready
。
此时请点击 Visit
,即可跳转到部署好的网站地址,此地址即为你的服务端地址。
HTML 引入 (客户端)
在你的网页中进行如下设置:
- 使用 CDN 引入 Waline:
//cdn.jsdelivr.net/npm/@waline/client
。 - 创建
<script>
标签使用Waline()
初始化,并传入必要的el
与serverURL
选项。el
选项是 Waline 渲染使用的元素,你可以设置一个字符串形式的 CSS 选择器或者一个 HTMLElement 对象。serverURL
是服务端的地址,即上一步获取到的值。
<head>
..
<script src="//cdn.jsdelivr.net/npm/@waline/client"></script>
...
</head>
<body>
...
<div id="waline"></div>
<script>
Waline({
el: '#waline',
serverURL: 'https://your-domain.vercel.app',
});
</script>
</body>
- 评论服务此时就会在你的网站上成功运行