logo
0
0
WeChat Login
Huazie<huazie.lgh@gmail.com>
Mod: 添加模板引擎支持描述

Hexo Comments Utterances

NPM version Required Node.js version Required Hexo version License GitHub Repo stars

轻松集成 Utterances 评论系统到您的 Hexo 博客中,基于 GitHub Issues 的轻量级评论解决方案。

英文说明/English Documentation

功能特性

特性描述优势
轻量级基于 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 仓库地址

配置选项详解

选项类型默认值必填描述
enableBooleanfalse是否启用 Utterances 评论系统
loadingBooleantrue是否显示评论加载动画
repoString-GitHub 仓库,格式:username/repo-name
issue_termStringpathname映射评论到 issue 的方式
themeStringgithub-light亮色模式主题
darkStringgithub-dark暗色模式主题

高级配置选项

issue_term 映射方式

描述适用场景
pathname使用页面路径作为 issue 标题推荐,适合大多数场景
url使用页面完整 URL 作为 issue 标题需要包含域名信息时
title使用页面标题作为 issue 标题希望 issue 标题更友好
og:title使用页面 Open Graph 标题SEO 优化场景
[issue-number]指定特定的 issue 编号手动管理评论
[specific-term]使用特定术语作为标题自定义标识符

主题样式选项

主题名特点
github-lightGitHub 官方亮色主题
boxy-light盒子风格亮色主题
github-darkGitHub 官方暗色主题
github-dark-orangeGitHub 暗橙色主题
icy-dark冰蓝暗色主题
dark-blue深蓝暗色主题
photon-dark光子暗色主题
preferred-color-scheme自动跟随系统主题

支持的模板引擎

本插件支持所有使用以下模板引擎的 Hexo 主题:

模板引擎文件扩展名支持状态
EJS.ejs✅ 完全支持
Nunjucks.njk✅ 完全支持
JSX + Inferno.jsx✅ 完全支持

使用前提

在开始使用之前,请确保满足以下条件:

1. GitHub 仓库准备

  • 拥有一个 公开的 GitHub 仓库
  • 仓库已启用 Issues 功能

2. 安装 Utterances App

  • 访问 Utterances GitHub App
  • 点击 "Install" 并选择您的仓库
  • 授权 Utterances 访问您的仓库

提示:Utterances App 只需要 Issues 的读写权限,非常安全

工作原理

详细流程

  1. 页面加载:访问者打开页面,Utterances 脚本开始工作
  2. 搜索 Issue:根据配置的 issue_term 在指定仓库中搜索相关 Issue
  3. 显示评论:如果找到对应 Issue,显示其中的评论
  4. 创建 Issue:首次评论时,自动创建新的 Issue
  5. GitHub 登录:访问者需要 GitHub 账号才能参与评论

相关链接

官方资源

Hexo 文档

相关插件

许可证

本项目基于 MIT 许可证开源。