轻松集成 Utterances 评论系统到您的 Hexo 博客中,基于 GitHub Issues 的轻量级评论解决方案。
| 特性 | 描述 | 优势 |
|---|---|---|
| 轻量级 | 基于 GitHub Issues,无需数据库 | 零维护成本,高可用性 |
| 安全可靠 | 完全开源,无广告无追踪 | 保护用户隐私,透明可信 |
| 主题切换 | 支持亮色/暗色主题自动切换 | 完美适配各种主题风格 |
| 响应式设计 | 适配各种设备屏幕 | 移动端友好的用户体验 |
| 即时加载 | 支持懒加载和加载动画 | 优化页面性能 |
| 易于配置 | 简单的 YAML 配置 | 快速上手,灵活定制 |
# 1. 安装多评论系统核心插件(必需)
npm install hexo-generator-comments --save
# 2. 安装 Utterances 评论插件
npm install hexo-comments-utterances --save
提示:
hexo-comments-utterances需要与hexo-generator-comments搭配使用 更多信息:hexo-generator-comments
在 Hexo 站点配置 _config.yml 或 主题配置 _config.yml 、_config.[theme].yml 中添加以下内容:
utterances:
# 是否启用 Utterances 评论系统
enable: false
# 是否启用加载提示,可选值:`true` | `false`
loading: true
# GitHub仓库所有者和名称,格式为 username/repo-name
repo: your-username/your-repo-name
# 指定issue的匹配规则
issue_term: pathname
# 亮色主题
theme: github-light
# 暗色主题
dark: github-dark
重要:请将
your-username/your-repo-name替换为您的实际 GitHub 仓库地址
| 选项 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
enable | Boolean | false | 是 | 是否启用 Utterances 评论系统 |
loading | Boolean | true | 是 | 是否显示评论加载动画 |
repo | String | - | 是 | GitHub 仓库,格式:username/repo-name |
issue_term | String | pathname | 是 | 映射评论到 issue 的方式 |
theme | String | github-light | 是 | 亮色模式主题 |
dark | String | github-dark | 是 | 暗色模式主题 |
issue_term 映射方式
| 值 | 描述 | 适用场景 |
|---|---|---|
pathname | 使用页面路径作为 issue 标题 | 推荐,适合大多数场景 |
url | 使用页面完整 URL 作为 issue 标题 | 需要包含域名信息时 |
title | 使用页面标题作为 issue 标题 | 希望 issue 标题更友好 |
og:title | 使用页面 Open Graph 标题 | SEO 优化场景 |
[issue-number] | 指定特定的 issue 编号 | 手动管理评论 |
[specific-term] | 使用特定术语作为标题 | 自定义标识符 |
主题样式选项
| 主题名 | 特点 |
|---|---|
github-light | GitHub 官方亮色主题 |
boxy-light | 盒子风格亮色主题 |
github-dark | GitHub 官方暗色主题 |
github-dark-orange | GitHub 暗橙色主题 |
icy-dark | 冰蓝暗色主题 |
dark-blue | 深蓝暗色主题 |
photon-dark | 光子暗色主题 |
preferred-color-scheme | 自动跟随系统主题 |
本插件支持所有使用以下模板引擎的 Hexo 主题:
| 模板引擎 | 文件扩展名 | 支持状态 |
|---|---|---|
| EJS | .ejs | ✅ 完全支持 |
| Nunjucks | .njk | ✅ 完全支持 |
| JSX + Inferno | .jsx | ✅ 完全支持 |
在开始使用之前,请确保满足以下条件:
提示:Utterances App 只需要 Issues 的读写权限,非常安全
issue_term 在指定仓库中搜索相关 Issue本项目基于 MIT 许可证开源。