本文档详细介绍 jijian 主题的各项功能配置方法,包含评论系统、搜索功能、代码高亮、社交图标、图片灯箱等。
评论系统
jijian 主题支持 Giscus 评论系统,基于 GitHub Discussions 实现。
启用评论
在 hugo.yaml 中配置:
|
|
配置 Giscus
1. 准备工作
确保你的 GitHub 仓库满足以下条件:
- 仓库是公开的(Public)
- 已启用 Discussions 功能
- 已安装 giscus app
2. 获取配置参数
访问 giscus.app ,按照向导配置:
- 输入仓库地址
- 选择页面与 Discussions 映射方式(推荐
pathname) - 选择 Discussion 分类(推荐
Announcements) - 复制生成的配置参数
3. 添加配置
将获取的参数添加到 hugo.yaml:
|
|
文章级控制
在文章的 Front Matter 中可以单独控制:
|
|
或禁用特定文章的评论:
|
|
搜索功能
jijian 主题使用 Pagefind 作为搜索引擎,提供高性能的全文搜索体验。
配置搜索页面
1. 添加菜单项
在 hugo.yaml 中配置:
|
|
2. 创建搜索页面
创建 content/search/_index.md:
|
|
构建搜索索引
Pagefind 需要在 Hugo 构建后运行,生成搜索索引。
本地开发预览
场景一:边开发边测试(推荐)
|
|
注意:修改文章后需要重新运行第一条命令更新索引。
场景二:预览最终构建文件
|
|
Vercel 自动化部署
在 Vercel 构建命令中添加索引生成:
Build Command:
|
|
package.json(可选):
|
|
Pagefind 配置选项
搜索页支持自定义配置:
|
|
代码高亮
jijian 主题内置 13 款 Chroma 语法高亮样式。
选择高亮样式
在 hugo.yaml 中配置:
|
|
可用样式列表
| 样式名称 | 说明 |
|---|---|
catppuccin-macchiato |
默认样式,与主题配色协调 |
catppuccin-mocha |
Catppuccin 深色变体 |
catppuccin-frappe |
Catppuccin 中等深度 |
catppuccin-latte |
Catppuccin 浅色版本 |
github |
GitHub 浅色风格 |
github-dark |
GitHub 深色风格 |
monokai |
经典 Monokai 配色 |
dracula |
Dracula 主题配色 |
nord |
Nord 极光配色 |
tokyonight-night |
Tokyo Night 深色 |
gruvbox |
Gruvbox 复古配色 |
onedark |
Atom OneDark 风格 |
solarized-dark |
Solarized 深色 |
显示行号
|
|
代码块示例
|
|
显示效果(带行号和复制按钮):
|
|
社交图标
jijian 主题支持丰富的社交图标,包括国内外主流平台。
基本配置
|
|
悬浮二维码功能
配置 hoverImage 参数后,鼠标悬停在图标上会弹出图片/二维码:
|
|
支持的平台
国内平台
| name | 平台 |
|---|---|
bilibili |
哔哩哔哩 |
douyin |
抖音 |
xiaohongshu |
小红书 |
shipinhao |
视频号 |
zhihu |
知乎 |
douban |
豆瓣 |
weibo |
微博 |
wechat |
微信 |
国际平台
| name | 平台 |
|---|---|
github |
GitHub |
twitter / x |
Twitter/X |
linkedin |
|
youtube |
YouTube |
instagram |
|
facebook |
|
email |
邮箱 |
rss |
RSS |
参数说明
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
name |
string | 是 | 平台名称 |
url |
string | 是 | 链接地址 |
title |
string | 否 | 鼠标悬停显示的文字 |
hoverImage |
string | 否 | 悬浮图片路径 |
图片路径说明
悬浮二维码图片应放在 static/img/ 目录下:
your-site/
├── static/
│ └── img/
│ ├── wechat-qr.png
│ ├── bilibili-qr.png
│ └── douyin-qr.png
配置时使用绝对路径:
|
|
分享按钮
文章页支持社交分享按钮。
启用分享
|
|
配置分享平台
|
|
文章级控制
在文章的 Front Matter 中可以禁用分享:
|
|
图片灯箱
jijian 主题内置 medium-zoom 图片缩放功能。
功能特点
- 点击图片平滑放大
- 支持滚轮缩放
- 背景色自动适配主题
- 智能过滤带链接的图片
自动启用
所有文章内的图片默认支持灯箱效果,无需额外配置。
跳过灯箱
如果图片设置了链接(使用 figure 短代码的 link 参数),点击会跳转链接,不触发灯箱:
|
|
文章元信息
显示控制
|
|
中文优化
主题针对中文进行了优化:
- 精确统计汉字、标点、字母、数字
- 基于字数计算阅读时长
- 支持自定义阅读速度
文章级控制
|
|
目录
基本配置
|
|
悬浮模式
|
|
悬浮模式说明:
- 鼠标悬停时才显示目录
- 点击后目录保持显示
- 适合长文章,不占用页面空间
文章级控制
|
|
面包屑导航
|
|
面包屑导航显示当前页面在站点结构中的位置:
首页 > 文章 > 技术分享 > 当前文章
上下篇导航
|
|
在文章底部显示上一篇和下一篇文章的链接。
文章级控制
|
|
编辑文章链接
|
|
完整链接示例:
https://github.com/user/repo/tree/main/content/posts/my-article.md
RSS 订阅
输出配置
|
|
显示 RSS 按钮
|
|
RSS 路径
- 全站 RSS:
/index.xml - 分类 RSS:
/categories/分类名/index.xml - 标签 RSS:
/tags/标签名/index.xml
页脚配置
jijian 主题支持自定义页脚文本(如备案号、版权声明)以及 Shields.io 风格的徽标展示。
基本配置
在 hugo.yaml 中配置:
|
|
页脚徽标 (Badges/Shields)
你可以在页脚文字上方显示一行精美的徽标(建议使用 Shields.io 生成)。
配置示例
|
|
参数说明
| 参数 | 说明 |
|---|---|
url |
点击徽标后的跳转链接 |
badge |
徽标图片地址。支持 Shields.io 远程 URL 或本地路径(如 /badges/cdn.svg) |
title |
鼠标悬停在徽标上时显示的文字提示 |
徽标本地化推荐
为了提高加载速度并脱离第三方服务依赖,你可以将生成的徽标 SVG 下载并存放在 static 目录中:
- 下载 SVG 到
static/badges/myshield.svg。 - 配置时将
badge参数设为本地路径:badge: "/badges/myshield.svg"。
图片与封面配置
jijian 主题引入了双层图片系统,分别处理外部分享和内部展示。
全局配置
在 hugo.yaml 中配置:
|
|
封面图可见性控制
默认情况下,封面图会在文章列表(悬浮预览)和文章详情页顶部(全景横幅)显示。
但是,如果你没有为每一篇文章都准备专门的封面图,全局设置的 defaultImage 可能会导致所有文章顶部都显示同一张图,显得冗余。
你可以通过以下方式灵活控制具体文章及全局的封面显示:
全局控制:是否显示保底图
如果你只想让默认图片显示在列表悬浮窗和搜索结果中,而不在文章内容顶部显示,请在全局配置中保持 displayDefault: false:
|
|
如果你希望即便文章未设置封面,也让默认图充当顶部的 Banner,则将其设为 true。
文章级控制:隐藏封面
如果你希望彻底隐藏某篇文章的封面,无论是否有默认值,都可以在文章 Front Matter 中设置:
|
|
提示:即使配置了 hidden: true,只要设置了 defaultImage 或自定义了 cover.image,Pagefind 搜索结果中依然可以显示该文章的缩略图,这能保证搜索体验不受影响。
图片素材规格推荐
为了保证主题视觉效果的最佳呈现,建议按照以下规格准备图片素材:
| 素材类型 | 推荐比例 | 推荐尺寸 (像素) | 说明 |
|---|---|---|---|
| 头像 (Avatar) | 1:1 (正方形) |
240 x 240 |
用于 Card Mode 首页,建议使用 Retina 倍率以保证清晰度 |
| 分享图 (shareImages) | 1.91:1 |
1200 x 630 |
国际主流社交平台 (OpenGraph) 的标准比例 |
| 文章封面 (Cover) | 16:9 或 32:9 |
1920 x 1080 (及以上) |
文章页顶部会自动裁剪为 32:9 的超宽视野。建议主体内容居中。 |
| 站点 Logo | 横向长矩形 | 高度固定 32px |
建议使用 SVG 格式,以获得在任何缩放倍率下的极致清晰度 |
| Favicon | 1:1 |
32 x 32 / 180 x 180 |
提供 .ico 和 .png 两种格式的最佳适配 |
关于文章封面的特别说明:
jijian 主题在文章详情页采用了“电影全景式” Banner 设计(比例为 32:9)。如果你上传的是标准的 16:9 图片,主题会自动保留图片的中间部分。因此在构图时,请尽量将图片的视觉重心(主体人物或文字)放在垂直正中心,以防被切掉。
SEO 优化
基本配置
|
|
搜索引擎验证与统计
支持 Google、Bing、Yandex、Naver 的站点验证标签,以及百度统计。
1. 站点验证标签
|
|
2. 百度统计 (Baidu Analytics)
支持在站点中集成百度统计脚本。
|
|
对于多域名的博客,每个域名都需要单独配置百度统计。因此可以使用环境变量的形式来配置:HUGO_PARAMS_ANALYTICS_BAIDU_HM = 你的百度统计ID
文章级 SEO
|
|
主题切换
|
|
主题模式:
light:浅色主题dark:深色主题auto:跟随系统设置
加载评论中...
哎呀!Giscus评论模块加载失败啦~
Giscus是基于Github Discussions的,或许当前网络无法访问Github哦!