主题
配置文章页评论系统。本主题集成 Twikoo 评论系统,由 enable 统一开关。Twikoo 是一款开源自部署的评论服务,数据完全由自己掌控,部署与使用方式参考 Twikoo 文档。
enable
boolean
false
twikoo
TwikooConfig
envId
string
''
region
string?
ap-shanghai
lang
'zh-CN'
import { defineThemeConfig } from 'vitepress-theme-ninc/defineThemeConfig' export const themeConfig = defineThemeConfig({ comment: { enable: true, twikoo: { envId: 'https://your-twikoo-env.vercel.app/', lang: 'zh-CN' } } })
comment 渲染在文章正文末尾,启用后展示完整的 Twikoo 评论区:
comment
localStorage["twikoo"]
常见配置组合
lang: 'zh-CN'
siteMeta.lang
twikoo.lang
en
zh-TW
反垃圾与邮件通知
Twikoo 支持配置垃圾评论过滤(Akismet)与邮件通知(SMTP),需在 Twikoo 后台「配置管理」中单独设置,不在主题配置范围内。建议启用以避免垃圾评论泛滥。
使用前需自建 Twikoo 服务
Twikoo 为开源自部署方案,使用前需先部署服务端。常见部署方式:
twikoo.envId
envId 的填写方式
twikoo.envId 的取值取决于部署方式:
https://your-twikoo-env.vercel.app/
env-xxxxxxxx
region 仅云函数部署时使用
twikoo.region 仅在使用腾讯云 CloudBase 云函数部署 Twikoo 时需要填写,取值为地域标识(如 ap-shanghai、ap-guangzhou)。使用 Vercel 部署时无需填写该字段。
twikoo.region
ap-guangzhou
enable 为总开关
comment.enable 控制评论系统的整体启停。设为 false 时文章页不会渲染任何评论组件,即使 twikoo.envId 已填写也不会发起请求。
comment.enable
配置会与默认值深合并,只需填写想修改的字段,详见 主题配置详解 - defu 深合并机制。
自定义样式需使用 #twikoo 选择器
主题加载的是 twikoo/dist/twikoo.nocss.js(无 CSS 版本),Twikoo 自身的样式由主题包统一加载与定制。如需覆盖评论样式,应使用 #twikoo 选择器编写自定义 SCSS,并在主题样式之后导入,否则可能被主题样式覆盖。
twikoo/dist/twikoo.nocss.js
#twikoo
#twikoo { .tk-input .el-textarea__inner { border-radius: 12px; } }
用户信息存储位置
访客在评论框中填写的昵称、邮箱、网站等信息由 Twikoo 写入浏览器本地存储,键名为 localStorage["twikoo"]。清除该键即可重置访客信息。
aside
rewardData
fancybox
comment 评论
配置文章页评论系统。本主题集成 Twikoo 评论系统,由
enable统一开关。Twikoo 是一款开源自部署的评论服务,数据完全由自己掌控,部署与使用方式参考 Twikoo 文档。字段说明
comment 主表
enablebooleanfalsetwikooTwikooConfigtwikoo 子表(TwikooConfig)
envIdstring''regionstring?ap-shanghai),仅云函数部署时使用langstring?'zh-CN'示例
渲染效果
comment渲染在文章正文末尾,启用后展示完整的 Twikoo 评论区:localStorage["twikoo"]。常见配置组合
lang: 'zh-CN',零成本即可启用。siteMeta.lang同步设置twikoo.lang(如en、zh-TW)。region,搭配云数据库备份。反垃圾与邮件通知
Twikoo 支持配置垃圾评论过滤(Akismet)与邮件通知(SMTP),需在 Twikoo 后台「配置管理」中单独设置,不在主题配置范围内。建议启用以避免垃圾评论泛滥。
注意事项
使用前需自建 Twikoo 服务
Twikoo 为开源自部署方案,使用前需先部署服务端。常见部署方式:
twikoo.envId。envId 的填写方式
twikoo.envId的取值取决于部署方式:https://your-twikoo-env.vercel.app/)。env-xxxxxxxx)。region 仅云函数部署时使用
twikoo.region仅在使用腾讯云 CloudBase 云函数部署 Twikoo 时需要填写,取值为地域标识(如ap-shanghai、ap-guangzhou)。使用 Vercel 部署时无需填写该字段。enable 为总开关
comment.enable控制评论系统的整体启停。设为false时文章页不会渲染任何评论组件,即使twikoo.envId已填写也不会发起请求。自定义样式需使用 #twikoo 选择器
主题加载的是
twikoo/dist/twikoo.nocss.js(无 CSS 版本),Twikoo 自身的样式由主题包统一加载与定制。如需覆盖评论样式,应使用#twikoo选择器编写自定义 SCSS,并在主题样式之后导入,否则可能被主题样式覆盖。用户信息存储位置
访客在评论框中填写的昵称、邮箱、网站等信息由 Twikoo 写入浏览器本地存储,键名为
localStorage["twikoo"]。清除该键即可重置访客信息。相关配置
aside侧边栏 — 文章页侧边栏模块配置rewardData打赏 — 文章页打赏二维码配置fancybox灯箱 — 文章页图片灯箱配置