Artalk
Artalk 是一款简洁的自托管评论系统,你可以在服务器上轻松部署并集成到前端页面中。
在你的博客或任意页面部署 Artalk 评论框,为页面添加丰富的社交功能。
使用
npm i -D artalk请配置 provider: "Artalk",并将你的服务端地址传入 server 选项:
import { commentPlugin } from '@vuepress/plugin-comment'
export default {
plugins: [
commentPlugin({
provider: 'Artalk',
server: 'https://artalk.example.com',
}),
],
}Artalk 的选项继承自 Artalk 配置,所有可序列化的选项都可以直接在插件选项中配置。
部署服务端
请参见 Artalk 文档。
夜间模式
为了能使 Artalk 应用正确的主题,你需要通过 <CommentService /> 的 darkmode 属性传入一个布尔值,代表当前是否开启夜间模式。插件会将其转发给 Artalk 的 darkMode 选项。
选项
以下选项为插件的保留选项,会根据 VuePress 上下文自动推断:
elmanaged-by: 插件
string | HTMLElement容器元素,由 VuePress 配置推断。
pageTitlemanaged-by: 插件
string页面标题,由 VuePress 页面推断。
pageKeymanaged-by: 插件
string页面键名,由 VuePress 路由推断。
sitemanaged-by: 插件
string站点名称,由 VuePress 站点配置推断。
提示
imgUploader 和 avatarURLBuilder 这两个函数选项只能在客户端配置中设置。
客户端配置
你可以使用 defineArtalkConfig 函数来配置 Artalk:
import { defineArtalkConfig } from '@vuepress/plugin-comment/client'
import { defineClientConfig } from 'vuepress/client'
defineArtalkConfig({
// Artalk 选项
})