hugo-theme-reimu

💘 博麗霊夢 💘

演示网站 | 迁移指南 | Change Log

简体中文 | English

A Hakurei Reimu style Hugo theme. Migrated from hexo-theme-reimu.

framework	repository	version	stars
Hexo	hexo-theme-reimu
Hugo	hugo-theme-reimu
Astro	astro-theme-reimu

欢迎提出 Issue 和 PR！

特性

基础功能

✨ 完整的博客功能
🔄 兼容 Hugo 0.124.0 及以上版本
📱 响应式布局
🌙 暗黑模式支持
🅰️ i18n 支持

代码与数学

🖥️ 代码高亮与复制
➗ KaTeX / MathJax3 数学公式支持
📊 Mermaid 流程图支持

搜索与评论

🔍 Algolia 搜索集成
💬 多评论系统支持：
- Valine
- Waline
- Twikoo
- Gitalk
- Giscus
- Disqus
- Utterances
- Beaudar

统计与分析

📊 文章阅读统计（Valine / Waline）
👥 访客统计（不蒜子）

媒体与交互功能

🎵 音乐播放器支持：
- Aplayer
- Meting
🖼️ 图片懒加载
⚡ 加载动画
🖱️ 鼠标特效：
- 动画效果
- 灵梦鼠标指针
👾 Live2D / Live2D-widgets 集成

导航与结构

📑 目录导航
🔄 PJAX 支持
🔧 ServiceWorker 实现
📰 RSS 订阅

设计与自定义

🎨 图标支持：
- Iconfont
- FontAwesome7
🔗 内置短代码：
- 内部链接
- 外部链接
- 友情链接
- 热力图
- 标签轮盘
- Alert块引用
- 标签页
- 照片墙
🎨 动态适配主题色
©️ 文章版权声明
🌐 自定义 CDN 源 / 本地配置
📜 自定义字体
🎨 分享卡片功能

安装

纯小白可以直接使用 hugo-reimu-template。只需克隆仓库-修改配置即可获得一个基本的博客！

方式 1：Hugo Module（推荐）

适用于熟悉 Go 生态的用户，支持版本管理和自动更新。

hugo new site quickstart
cd quickstart
hugo mod init github.com/<your-github-username>/quickstart  # 请替换 <your-github-username>
echo 'theme = ["github.com/D-Sketon/hugo-theme-reimu"]' >> hugo.toml
hugo server

方式 2：Git Submodule

适用于希望手动管理主题版本的用户。

hugo new site quickstart
cd quickstart
git init
git submodule add https://github.com/D-Sketon/hugo-theme-reimu.git themes/reimu
echo 'theme = "reimu"' >> hugo.toml
hugo server

选择适合你的安装方式，即可开始使用 Hugo Theme Reimu！

使用

创建配置

主题配置

在外层 config 文件夹下创建 _default 文件夹，然后将主题内的 config/_default/params.yml 复制到 _default 文件夹下，此文件作为主题配置文件，可在此文件中修改主题配置

数据配置

将主题内的 config/data/ 文件夹内的所有文件复制到外层 data 文件夹下，此文件夹内的文件用于配置主题内的数据：

covers.yml 用于配置随机封面图片
friends.yml 用于配置友链
vendor.yml 用于配置第三方库的 CDN 源

静态资源配置

主题的静态资源（Favicon，头图等）位于 static 文件夹内，你可以在外层 static 文件夹下创建相应的文件夹，然后将主题内的文件复制到外层文件夹下，以覆盖主题内的默认文件

总之一句话，不建议直接修改主题内的文件，而是在外层创建相应的文件夹，然后将主题内的文件复制到外层文件夹下，以覆盖主题内的默认文件，这样便于主题升级

语言配置

reimu 支持多语言。如果你想要使用中文，请在 hugo.toml 中添加如下配置

languageCode = 'zh-CN'
defaultContentLanguage = 'zh-CN'
[languages]
[languages.zh-CN]
languageName = '简体中文'
weight = 1
hasCJKLanguage = true

基本结构

为了保证显示正确，请参考 _example 在 content 中建立 archives 和 post 文件夹（里面的 _index.md 不可省略，且注意 post 的 draft 为 true）

post

文章请在此目录下创建，注意 draft 为 true 的文章不会显示在首页

_index.md 用于忽略 post/index.html 的生成，不可省略

about.md

关于页面

friend.md

友链页面

头像、封面、头图和图标

头像、封面、头图和Favicon

头像

头像应保存于 static/avatar/avatar.webp，可在 params.yml 中修改文件名

avatar: "avatar.webp"

封面

随机封面图片请参考主题内的 data/covers.yml 文件结构，在外层 data 文件夹下创建 covers.yml 文件，格式如下：

- https://example.com/1.jpg
- https://example.com/2.jpg

banner 和 cover 的显示逻辑如下：

文章页头图优先使用 Front matter 的 banner；若未设置 banner，则兼容使用 cover
列表卡片封面优先使用 Front matter 的 cover（仅 URL 生效）；当 cover 未设置、为 false 或 rgb(...) 时，会回退到 data/covers.yml 随机图
若随机封面不可用，则回退到全局 banner

推荐写法（头图与卡片封面分离）：

---
title: Hello World
banner: https://example.com/post-header.webp
cover: https://example.com/post-card.webp
---

兼容旧写法（只写 cover）：

---
title: Hello World
cover: https://example.com/cover.webp
---

头图

头图保存于 themes/hugo-theme-reimu/static/images/banner.webp，可在 params.yml 中修改路径和名字

banner: "images/banner.webp"

Favicon

Favicon 保存于 themes/hugo-theme-reimu/static/favicon.ico，可自行覆盖替换

文章总结

默认关闭，可选择在副标题或者文章开头显示文章摘要

summary:
  enable: false
  style: 'subtitle' # 'subtitle' | 'blockquote'

侧边栏

侧边栏位置

默认在右边，可在 params.yml 中修改

sidebar:
  position: right # left | right | false
  menu: true # 是否显示侧边栏菜单按钮，移动端忽略
  article:
    show_common: true # 文章页是否显示通用侧边栏，移动端忽略

此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置

---
sidebar: left # left | right | false
---

当 sidebar 设置为 false 时，侧边栏将被隐藏，此时 aplayer 播放器和 widgets 小部件将同时无法显示

社交链接

可在 params.yml 中配置侧边栏中的社交链接，支持对象与数组两种写法（二选一）

写法 1：对象（兼容旧格式）

social:
  github: https://github.com/yourname
  bilibili: https://space.bilibili.com/yourname
  # weixin: https://example.com/your-weixin-link
  # qq: https://example.com/your-qq-link
  tiktok: https://www.tiktok.com/@yourname

写法 2：数组（新支持）

social:
  - name: github
    url: https://github.com/yourname
  - name: tiktok
    url: https://www.tiktok.com/@yourname

侧边栏小部件

可在 params.yml 中配置侧边栏小部件

widgets:
  - category # 分类
  - tag # 标签
  - tagcloud # 标签云
  - recent_posts # 最近文章

此外，可使用如下配置对小部件进行行为配置

category_limits: 10 # 分类数量限制
tag_limits: 10 # 标签数量限制
recent_posts_limits: 5 # 最近文章数量限制
tagcloud_limits: 20 # 标签云数量限制

页脚

基础信息

页脚部分允许您配置基本显示信息和统计数据

footer:
  since: 2020 # 在版权信息中显示的起始年份（例如：2020-当前年份）
  powered: true # 是否显示版权信息
  count: true # 是否显示字数统计和阅读时间信息
  busuanzi: true # 是否启用不蒜子访客统计功能

ICP 备案

对于托管在中国大陆的网站，可以根据法规要求显示ICP备案信息

icp:
  icpnumber: # ICP备案号
  beian: # 网安备案号
  recordcode: # 网安备案链接中的recordcode参数

萌国 ICP 备案 (v0.12.1+)

萌国 ICP 备案

moe_icp:
  icpnumber: # 萌国ICP备案号

代码块

为保证代码块的正确显示，请保证 hugo.toml 中有如下配置

[markup.highlight]
guessSyntax = true
noClasses = false

代码块同时提供了代码复制功能，点击代码块右上角的复制按钮即可复制代码。在 params.yml 中可以对复制功能进行配置。
success 为复制成功时的提示，fail 为复制失败时的提示。此外，可以配置版权声明，当复制的字符数大于 count 时会在复制的内容后面添加版权声明。

clipboard:
  success:
    en: Copy successfully (*^▽^*)
    zh-CN: 复制成功 (*^▽^*)
    zh-TW: 複製成功 (*^▽^*)
    ja: コピー成功 (*^▽^*)
  fail:
    en: Copy failed (ﾟ⊿ﾟ)ﾂ
    zh-CN: 复制失败 (ﾟ⊿ﾟ)ﾂ
    zh-TW: 複製失敗 (ﾟ⊿ﾟ)ﾂ
    ja: コピー失敗 (ﾟ⊿ﾟ)ﾂ
  copyright:
    enable: false
    count: 50 # 大于多少字符添加版权声明
    license_type: by-nc-sa # https://creativecommons.org/licenses

v0.2.0 添加了配置用于控制代码块的默认展开状态，expand 可以设置为 true、false 或数字，数字表示当代码块的行数大于该数字时默认收缩。

code_block:
  expand: true # true | false | number

站内评论

站内评论可以使用 Front matter 中的 comments 独立控制每篇文章是否显示评论。
当 comments 为 false 时不显示评论，true 或不填时根据 params.yml 的配置决定是否显示。

0.8.0+ 后支持多评论系统同时使用

全局评论系统配置：

comment:
  title: # 评论框标题
    en: Leave a comment
    zh-CN: 说些什么吧！
    zh-TW: 說些什麼吧！
    ja: コメントを残す
  default: waline # 多评论下，默认使用的评论系统

若基于 Valine
请参考其官方文档完成 LeanCloud 的配置，并在 params.yml 中将 valine.enable 改为 true，并填入自己的 appId 和 appKey

valine:
  enable: true
  appId: "your appId"
  appKey: "your appKey"
  pageSize: 10 # comment list page size
  avatar: mp # gravatar style https://valine.js.org/#/avatar
  # lang: zh-cn # deprecated, use html.lang instead
  placeholder: Just go go # valine comment input placeholder(like: Please leave your footprints )
  guest_info: nick,mail,link #valine comment header info
  recordIP: true # whether to record the IP address of the commenters
  highlight: true # whether to highlight the code blocks
  visitor: false # whether to display the number of visitors
  serverURLs: # leancloud server url

若基于 Waline
请参考其官方文档完成 LeanCloud 的配置，并在 params.yml 中将 waline.enable 改为 true，并填入自己的 serverURL

waline:
  enable: true
  serverURL: "your server url"
  locale: {} # https://waline.js.org/guide/features/i18n.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%AF%AD%E8%A8%80
  emoji:
    - https://unpkg.com/@waline/[email protected]/weibo
    - https://unpkg.com/@waline/[email protected]/alus
    - https://unpkg.com/@waline/[email protected]/bilibili
    - https://unpkg.com/@waline/[email protected]/qq
    - https://unpkg.com/@waline/[email protected]/tieba
    - https://unpkg.com/@waline/[email protected]/tw-emoji
  meta:
    - nick
    - mail
    - link
  requiredMeta:
    - nick
    - mail
  wordLimit: 0
  pageSize: 10
  pageview: true

若基于 twikoo
请参考其官方文档完成腾讯云或 Vercel 部署，并在 params.yml 中将 twikoo.enable 改为 true，并填入自己的 envId

twikoo:
  enable: true
  envId: # 腾讯云环境填 envId；Vercel 环境填地址（https://xxx.vercel.app）
  region:

若基于 giscus
请参考文档完成仓库的配置，并在 params.yml 中将 giscus.enable 改为 true，并填入对应的数据

giscus:
  enable: true
  repo: "your repo"
  repoId: "your repoId"
  category: "your category"
  categoryId: "your categoryId"
  mapping: mapping
  strict: 0
  reactionsEnabled: 1
  emitMetadata: 0
  inputPosition: bottom
  theme:
    light: # 可选，支持 giscus 内置主题名或自定义 CSS URL
    dark: # 可选，支持 giscus 内置主题名或自定义 CSS URL

说明：

Giscus 基于 iframe 渲染，无法直接继承站点全局样式，需要通过 data-theme 覆盖。
若 theme.light / theme.dark 使用 URL，主题会校验该地址是否允许 https://giscus.app 跨域访问；校验失败会自动回退到内置 light / dark。
两个 theme 留空时，会尝试使用主题内置的 Reimu 风格 CSS（与全站保持一致的鼠标样式、字体和静态 token；material_theme 等动态 token 不支持）。
本地 hugo server（HTTP 且通常无 CORS 头）与 github.io 默认静态资源场景通常无法直接通过 URL 主题校验，建议使用可配置 CORS 的资源域名（例如 jsDelivr 代理）。

若基于 gitalk
请参考其官方文档完成仓库的配置，并在 params.yml 中将 gitalk.enable 改为 true，并填入对应的数据

gitalk:
  enable: true
  clientID: "your application client ID"
  clientSecret: "your application client secret"
  repo: "your repo"
  owner: "repo owner"
  admin: "repo owner and collaborators"
  md5: false # 是否使用 md5 加密路径

若基于 Disqus
请在 params.yml 中将 disqus.enable 改为 true，并填入自己的 shortname

disqus:
  enable: true
  shortname: "your shortname"
  count: true # 是否启用评论数量统计

若基于 utterances
请在 params.yml 中将 utterances.enable 改为 true，并填入自己的 repo

utterances:
  enable: true
  repo: owner/repo # 这里需要修改为 你的 GitHub 用户名/刚刚创建的，用户保存博客评论的 GitHub 仓库名
  issue_term: title
  theme: github-light # 你可以使用 auto 来自动适配深色和浅色主题

若基于 beaudar
请在内层 _config.yml 中将 beaudar.enable 改为 true，并填入自己的 repo 和 branch。之后需要在仓库中创建一个域白名单 (Hexo 主题请把该文件直接放在 source 目录下)，并授权安装即可

beaudar:
  enable: true
  repo: owner/repo # 这里需要修改为 你的 GitHub 用户名/刚刚创建的，用户保存博客评论的 GitHub 仓库名
  branch: main # 这里修改为你的仓库分支名
  issue_term: title # 博客文章 与 Issue 的映射
  issue_number:
  theme: auto # 你可以使用 auto 来自动适配深色和浅色主题
  label:
  input_position: top # top/bottom 评论框的位置，默认顶部 top
  comment_order: desc # asc/desc 评论排序，默认降序 desc (新评论在顶部)
  keep_theme: # true/false 主题设置保存到页面的 sessionStorage，默认 true
  loading: # true/false 点击加载图标可跳转至官方页面

站内搜索

基于 Algolia，请在外层 hugo.toml 中添加如下配置

[outputs]
home = ["Algolia", "HTML", "RSS"]

[outputFormats.Algolia]
baseName = "algolia"
isPlainText = true
mediaType = "application/json"
notAlternative = true

这样会在 public 文件夹下生成 algolia.json 文件，用于 Algolia 搜索。接着你可以使用诸如 atomic-algolia 等插件将其上传到 Algolia

同时，在 params.yml 中将 algolia_search.enable 改为 true，并填写相关信息（注意！这里填写的是Search-Only Key，不允许填写Admin Key！！否则可能被攻击）

algolia_search:
  enable: true

数学公式

请先在外层 hugo.toml 中添加如下配置

[markup.goldmark.extensions.passthrough]
enable = true
delimiters.block = [["\\[", "\\]"], ["$$", "$$"]]
delimiters.inline = [["\\(", "\\)"], ["$", "$"]]

并在需要使用数学公式的文章的 Front matter 中添加 math 为 true

---
math: true
---

注意不要同时开启 KaTeX 和 MathJax3

KaTeX

若基于 KaTeX，请在 params.yml 中将 math.katex.enable 改为 true

math:
  katex:
    enable: true

MathJax3

若基于 MathJax3，请在 params.yml 中将 math.mathjax.enable 改为 true，并可在 options 中添加配置（由于 Hugo 会自动将对象的key转变为全小写，所以配置需要放在一个数组中避免默认行为）

math:
  mathjax:
    enable: true
    options: [{}]

Mermaid

流程图基于 Mermaid，请在需要使用流程图的文章的 Front matter 中添加 mermaid 为 true

---
mermaid: true
---

此外，可在 params.yml 中对 Mermaid 进行配置

mermaid:
  zoom: false # 是否启用缩放功能

RSS

RSS 可以在 params.yml 中配置

rss:
  limit: 10 # 输出最近的文章数量，写 -1 输出全部
  showFullContent: false # 是否输出文章的完整内容
  showCopyright: false # 是否输出版权声明

Icon

Icon 默认使用本项目提供的 Iconfont

icon_font: 4552607_a0oqhord1y

如果想要继续使用 FontAwesome 图标，请将 icon_font 设置为 false，此时会使用 vendor.yml 中对应的 FontAwesome

fontawesome:
  high_priority:
    - src: webcache|@fortawesome/[email protected]/css/regular.min.css
      integrity: sha384-4qYppzjH8EiA+cGdaubu2vL7Rk8WGiqCSj7oRuP1uwtFWkfKNHD20lPfcrbQc8dU
    - src: webcache|@fortawesome/[email protected]/css/solid.min.css
      integrity: sha384-wbMWab3UDSPm2kvIgVOn/d9KPTecgPU1+Nb3zoQrm/oVu0EkPL6IaKinjbwW0rum
  low_priority:
    - src: webcache|@fortawesome/[email protected]/css/brands.min.css
      integrity: sha384-KTGeC2hIMzpeQakhsmzB9bZfhCD5xZZCgI1iZH6f/O457SxzlkzTQg/WXFNoi3ih
    - src: webcache|@fortawesome/[email protected]/css/v5-font-face.min.css
      integrity: sha384-nJ1ThfldViXoLpJ6jlKcP2beas8BMbYq26SG9Hi8cH89bZi4RZ644v7helMCqJxd
    - src: webcache|@fortawesome/[email protected]/css/v4-font-face.min.css
      integrity: sha384-UlkrhOIvZxJFd4MElSUp7ow6/RUeYKi/orfCZIRRiOENFuQPIAA3T3HjYfmBRhNq

扩展功能

回到顶部

默认开启

top:
  enable: true
  position: right # left | right

暗黑模式

默认为 auto，根据用户系统设置自动切换。可以设置为 true 或 false 改变默认状态

dark_mode:
  # true 代表暗黑模式默认开启
  # false 代表暗黑模式默认关闭
  # auto 代表根据用户系统设置自动切换
  enable: auto # true | false | auto

站点统计

默认关闭，支持百度统计、谷歌统计和微软 Clarity

baidu_analytics: false
google_analytics: false
clarity: false

Pace 进度条

默认开启

pace:
  enable: true

Firework 鼠标特效

默认开启

firework:
  enable: true
  disable_on_mobile: false # 是否在移动端禁用，可以提高性能
  options: # mouse-firework 配置项

具体配置请查看 mouse-firework

PJAX

默认关闭

pjax:
  enable: false

ServiceWorker

默认关闭

service_worker:
  enable: false

Live2D

默认关闭

live2d:
  enable: false
  position: left # left | right

Live2D Widgets

默认关闭

live2d_widgets:
  enable: false
  position: left # left | right

Reimu 鼠标指针

默认开启

reimu_cursor: true

响应式头图

默认关闭，打开后并提供对应尺寸的图片和媒体查询可以在一定程度上提高移动端的 LCP

banner_srcset:
enable: false
srcset:
  - src: "images/banner-600w.webp"
    media: "(max-width: 479px)"
  - src: "images/banner-800w.webp"
    media: "(max-width: 799px)"
  - src: 
    - "/images/banner.avif"
    - "/images/banner.webp" #  支持数组形式的 fallback
    media: "(min-width: 800px)"

Quicklink

默认开启，打开后可以在用户停留在页面时预加载链接，提高用户体验

quicklink:
  enable: true
  timeout: 3000 # 预加载超时时间
  priority: true # 是否优先加载
  ignores: [] # 忽略的链接，仅支持字符串数组

文章版权声明

默认关闭

article_copyright:
  enable: false # 是否展示版权卡片？
  content:
    author: # true | false 版权卡片展示作者？
    link: # true | false 版权卡片展示链接？
    title: # true | false 版权卡片展示标题？
    date: # true | false 版权卡片展示创建日期？
    updated: # true | false 版权卡片展示更新日期？
    license: # true | false 版权卡片展示协议？
    license_type: by-nc-sa # https://creativecommons.org/licenses

此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置

---
copyright: true # 是否展示版权卡片？
---

文章过期提醒

默认关闭

outdate:
  enable: false
  daysAgo: 180 # 多少天前的文章算过期
  message:
    en: This article was last updated on {time}. Please note that the content may no longer be applicable.
    zh-CN: 本文最后更新于 {time}，请注意文中内容可能已不适用。
    zh-TW: 本文最後更新於 {time}，請注意文中內容可能已不適用。
    ja: この記事は最終更新日：{time}。記載内容が現在有効でない可能性がありますのでご注意ください。

赞助

默认关闭

sponsor:
  enable: false # 是否展示赞助二维码？
  tip: # 赞助提示
    zh-CN: 请作者喝杯咖啡吧
    zh-TW: 請作者喝杯咖啡吧
    en: Buy me a coffee
    ja: コーヒーを買ってください
  icon:
    url: "../images/taichi.png" # 赞助图标，相对于 css/main.css 的路径，所以需要向上一级才能找到 images 文件夹
    rotate: true # 是否旋转图标
    mask: true # 是否将图片作为遮罩（即只显示 png 图片的轮廓）
  qr:
      - name: 支付宝 # 二维码名称
      src: "sponsor/alipay.jpg" # 示例二维码路径，位于 static/sponsor/alipay.jpg

此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置

---
sponsor: true # 是否展示赞助二维码？
---

音乐播放器（v0.4.0+）

使用前建议先打开 PJAX，否则会出现播放器自动暂停的问题

使用Aplayer + Meting（可选）默认关闭

音乐播放器位置（v0.12.1+）

默认在 sidebar 之后

player:
  position: before_sidebar # before_sidebar / after_sidebar / after_widget

纯Aplayer

将 player.aplayer.enable 设置为 true，并在 player.aplayer.options 中参考 Aplayer Docs 进行配置

player:
  aplayer:
    enable: true
    options:
      audio: [] # audio list
      fixed:
      autoplay:
      loop:
      order:
      preload:
      volume:
      mutex:
      listFolded:
      lrcType:

Aplayer + Meting

同时将 player.aplayer.enable 和 player.meting.enable 设置为 true，并在 player.meting.options 中参考 Meting Docs 进行配置，player.aplayer.options 为 Aplayer 配置

player:
  aplayer:
    enable: true
    options:
      audio: [] # this option will be overwritten by meting
      fixed:
      autoplay:
      loop:
      order:
      preload:
      volume:
      mutex:
      listFolded:
      lrcType:
  meting:
    enable: true
    meting_api: # custom api
    options:
      id:
      server:
      type:
      auto:

分享链接/卡片（v0.5.0+）

默认关闭，目前支持 facebook、twitter、linkedin、reddit、weibo、qq、weixin。

share:
  # - facebook
  # - twitter
  # - linkedin
  # - reddit
  # - weibo
  # - qq
  # - weixin

weixin 状态下会生成带有二维码的分享卡片，可保存到本地后分享到微信朋友圈（注意：当文章封面存在跨域问题时，截图工具无法正确生成含图片的卡片）

首页目录卡片（v0.6.0+）

默认关闭，打开后可以在首页展示目录卡片，用于代替 widget 中的目录

home_categories:
  enable: false # 是否展示首页目录卡片？
  content:
    - categories: # 目录名称，字符串类型
      cover: # 卡片封面，不填则使用随机封面
    - categories:
      cover:

注入器（v0.6.3+）

用于注入自定义代码，其效果和 Hexo#Injector 类似，支持 head、 body 和 sidebar 注入

injector:
  head_begin: # 在 <head> 标签后注入代码
  head_end: # 在 </head> 标签前注入代码
  body_begin: # 在 <body> 标签后注入代码
  body_end: # 在 </body> 标签前注入代码
  sidebar_begin: # 在 <aside> 标签后注入代码
  sidebar_end: # 在 </aside> 标签前注入代码

Pangu 自动分割（v0.7.0+）

默认关闭，自动替你在文章中所有的中文字和半形的英文、数字、符号之间插入空白。

pangu:
  enable: false

三角徽标（v0.13.2+）

默认关闭，打开后会在右上角展示三角徽标，支持自定义链接和图标

triangle_badge:
  enable: false
  icon: github # 与 social 配置里的 icon 相同
  link: https://github.com/D-Sketon/hugo-theme-reimu

内置shortcode

friendsLink 友链卡片

{{< friendsLink >}}

无参数，直接读取 data/friends.yml 文件

postLinkCard 内链卡片 (不推荐，建议使用 link)

{{<postLinkCard path="?" cover="?" escape="?" >}}

不推荐使用，建议使用 link shortcode 代替

其中第一个参数为文章的 path；第二个参数（可选）为卡片展示的封面，如果设置为 auto 则自动使用博客的 banner；第三个参数（可选，true | false）表示文章标题是否被转义

externalLinkCard 外链卡片 (不推荐，建议使用 link)

{{<externalLinkCard title="?" link="?" cover="?">}}

不推荐使用，建议使用 link shortcode 代替

其中第一个参数为文章的标题；第二个参数为文章的外部链接，第三个参数（可选）为卡片展示的封面，如果设置为 auto 则自动使用缺省封面

heatMapCard 文章热力图 (v0.8.0+)

{{< heatMapCard levelStandard="?" >}}

其中第一个参数为热力图的等级标准（按照文章字数分级），默认为 "1000,5000,10000"

tagRoulette 标签轮盘 (v0.12.0+)

{{< tagRoulette tags="?" icon="?" >}}

tagRoulette 是一个互动元素，提供随机标签展示功能，点击按钮后会从预定义的标签池中随机抽取并展示一个标签。

tags：可选参数，指定标签池，多个标签用英文逗号(,)分隔；未提供时默认使用几个示例标签，例如：tags="记忆衰退,表达欲丧失,更加怠惰,无感,好想睡觉"
icon：可选参数，自定义触发按钮的图标，默认使用：🕹️（游戏手柄emoji），可替换为任何emoji或文字，如 🎲、🎯、🔄 等

alertBlockquote 块引用 (v0.12.1+)

{{< alertBlockquote type="?" >}}
Your content here
{{< /alertBlockquote >}}

适用于 Hugo v0.132.0 以下版本不能使用 Hugo Blockquote render hooks 的场景。

其中第一个参数为块引用的类型，可选参数为：note、tip、important、warning、danger

link 链接卡片 (v0.14.0+)

{{< link title="?" link/path="?" cover="?" escape="?" >}}

externalLinkCard 和 postLinkCard 的升级版，推荐使用。

title：链接卡片的标题，内链时可省略，自动使用文章标题
link/path：链接的 URL 地址，为保证兼容性，link 和 path 均可使用，二者效果相同
cover：卡片展示的封面，如果设置为 auto 则自动使用博客的 banner 或缺省封面
escape：文章标题是否被转义，取值true | false，默认为 true

tabs 标签页 (v0.14.0+)

{{< tabs [activeTab] ["center"] >}}
<!-- tabName -->
Tab content
<!-- tabName -->
Tab content
{{< /tabs >}}

从 next, volantis, stellar 主题借鉴而来，支持在文章中创建标签页切换效果。

activeTab：可选参数，指定默认激活的标签页下标，从 1 开始计数，默认为 1
"center"：可选参数，指定标签页标题居中显示，默认左对齐
tabName：每个标签页的标题，必须用  包裹，支持使用 @ + 图标十六进制代码展示图标，例：
- 标题 
- 图标 
- 图标+标题

gallery 照片墙 (v0.14.0+)

{{< gallery >}}
![alt text](image_url1)
![alt text](image_url2)
...
{{< /gallery >}}

将多张图片以照片墙的形式展示出来，支持自动排列和响应式布局。

grid 网格布局 (v0.14.1+)

{{< grid width=? col=? >}}
<!-- cell -->
内容1
<!-- cell -->
内容2
<!-- cell -->
内容3
{{< /grid >}}

将内容以网格的形式展示出来，支持响应式布局。

width：可选参数，设置最小列宽，如 300 表示最小列宽为 300px，默认值为 240
col：可选参数，设置固定列数，如 3 表示固定 3 列布局，默认值为自适应列数
使用  分隔每个网格单元，每个单元的内容会被独立渲染

details 折叠面板 (v0.14.1+)

{{< details summary="?" >}}
内容
{{< /details >}}

在文章中创建折叠面板。

summary：可选参数，设置折叠面板的标题

自定义主题

动态适配主题色 (v0.8.0+ 实验性功能)

默认关闭，打开后会基于 Google's Material You 的设计规范根据文章头图的主色调动态生成主题色

material_theme:
  enable: false # true | false

注意：当开启该功能时，会在 banner 的 img 元素上添加 crossorigin="anonymous" 属性，以获取图片的主色调，所以请确保你的图片服务器支持跨域访问，或使用第三方图片代理。

手动定制主题颜色

hugo-theme-reimu 主题支持通过 CSS 变量定制主题颜色，你可以通过修改 :root 伪类下的 CSS 变量来定制你的主题颜色。

v0.9.0 对外暴露了 internal_theme 配置用于定制主题颜色 token

internal_theme:
  light:
    --red-0: "#ff0000"
    --red-1: "#ff5252"
    --red-2: "#ff7c7c"
    --red-3: "#ffafaf"
    --red-4: "#ffd0d0"
    --red-5: "#ffecec"
    --red-5-5: "#fff3f3"
    --red-6: "#fff7f7"
    --color-red-6-shadow: "rgba(255, 78, 78, 0.6)"
    --color-red-3-shadow: "rgba(255, 78, 78, 0.3)"

    --highlight-nav: "#f5f5f5"
    --highlight-scrollbar: "#d6d6d6"
    --highlight-background: "#fdfdfd"
    --highlight-selection: "#e9e9e988"
    --highlight-foreground: "#24292e"
    --highlight-comment: "#7d7d7d"
    --highlight-red: "#d73a49"
    --highlight-orange: "#e36209"
    --highlight-yellow: "#cb911d"
    --highlight-green: "#22863a"
    --highlight-aqua: "#005cc5"
    --highlight-blue: "#032f62"
    --highlight-purple: "#6f42c1"
    --highlight-deletion: "#b31d28"
    --highlight-deletion-bg: "#ffeef0"
    --highlight-addition: "#22863a"
    --highlight-addition-bg: "#f0fff4"
  dark:
    --red-4: "rgba(255, 208, 208, 0.5)"
    --red-5: "rgba(255,228,228,0.15)"
    --red-5-5: "rgba(255,236,236,0.05)"
    --red-6: "rgba(255, 243, 243, 0.2)"

    --highlight-nav: "#222830"
    --highlight-scrollbar: "#454d59"
    --highlight-background: "#1e2027"
    --highlight-selection: "#51515155"
    --highlight-foreground: "#c9d1d9"
    --highlight-comment: "#8b949e"
    --highlight-red: "#ff7b72"
    --highlight-orange: "#ffa657"
    --highlight-yellow: "#ffcc66"
    --highlight-green: "#7ee787"
    --highlight-aqua: "#a5d6ff"
    --highlight-blue: "#79c0ff"
    --highlight-purple: "#d2a8ff"
    --highlight-deletion: "#ffa198"
    --highlight-deletion-bg: "#490202"
    --highlight-addition: "#7ee787"
    --highlight-addition-bg: "#04260f"

自定义字体

可通过以下配置定义谷歌字体：

# https://fonts.google.com/
font:
  enable: true # 是否启用谷歌字体
  article:
    - Mulish
    - Noto Serif SC
  code:
    # - Ubuntu Mono
    # - Source Code Pro
    # - JetBrains Mono

v0.2.0 添加了 local_font 配置用于定义本机字体，其优先级比谷歌字体低：

local_font:
  article:
    - "-apple-system"
    - PingFang SC
    - Microsoft YaHei
    - sans-serif
  code:
    - Menlo
    - Monaco
    - Consolas
    - monospace

v0.9.0 添加了 custom_font 配置用于定义自定义字体，其优先级最高：

custom_font:
  enable: true
  article:
    - css: https://fontsapi.zeoseven.com/292/main/result.css # 字体 css 文件
      name: LXGW WenKai # 字体名称
  code:

定制图标

头部 / 侧边栏图标

v0.1.0 的 menu 配置的结构发生了变化，允许用户自定义 icon。icon 为空时默认使用太极图标，你可以填写一个十六进制的数字来自定义 icon，同时支持 FontAwesome，icon font 和 false。

v0.10.2 icon 支持图片路径，如 /avatar/avatar.webp。

menu:
  - name: home
    url: /
    icon: # 不填默认使用太极图标
  - name: archives
    url: /archives
    icon: f0c1 # 你可以填写一个十六进制的数字来自定义 icon，支持 FontAwesome 和 icon font，如果填写 false 则不显示图标
  - name: about
    url: /about
    icon:
  - name: friend
    url: /friend
    icon:

底部 / 回到顶部 / 赞助图标

v0.1.0 的 footer、top、sponsor 配置均增加了 icon 配置用于自定义图标。

url 为图标的路径，相对于 css/main.css 的路径，所以需要向上一级才能找到 images 文件夹。
rotate 为是否旋转图标，默认为 true。
mask 是否将图片作为遮罩（即只显示 png 图片的轮廓），默认为 true。

footer:
  icon:
    url: "../images/taichi.png" # 相对于 css/main.css 的路径，所以需要向上一级才能找到 images 文件夹，支持 false 以隐藏图标
    rotate: true
    mask: true

top:
  icon:
    url: "../images/taichi.png"
    rotate: true
    mask: true

sponsor:
  icon:
    url: "../images/taichi.png" # 支持 false 以隐藏图标
    rotate: true
    mask: true

加载图标

v0.1.0 的 preloader 配置增加了 icon 配置用于自定义图标。icon 为空时默认使用内联的 svg（保证首屏加载速度），你可以填入一个链接来自定义加载图标。

不建议使用过大的图标，以免影响加载速度。

preloader:
  enable: true
  text:
    zh-CN: 少女祈祷中...
    zh-TW: 少女祈禱中...
    en: Loading...
    ja: 少女祈祷中...
  icon: # 不填默认使用内联的 svg（保证首屏加载速度），你可以填入一个链接来自定义加载图标，如 '/images/taichi.png'
  rotate: true

锚点图标

v0.1.0 增加了 anchor_icon 配置用于自定义锚点图标，默认使用 # 图标，你可以填写一个十六进制的数字来自定义 icon，同时支持 FontAwesome 和 icon font。

anchor_icon: # 不填默认使用 # 图标

v0.11.0 anchor_icon 支持传递 false 以隐藏锚点图标

鼠标图标（v0.5.0+）

v0.5.0 增加了 reimu_cursor.cursor 配置用于自定义鼠标图标，你可以填写一个相对于 css/main.css 的路径来自定义鼠标图标。

reimu_cursor:
  enable: true
  cursor:
    default: ../images/cursor/reimu-cursor-default.png
    pointer: ../images/cursor/reimu-cursor-pointer.png
    text: ../images/cursor/reimu-cursor-text.png

自定义滚动动画

基于 AOS.js 实现的滚动动画效果，默认为 true，可以通过以下配置开启或关闭，并为不同页面设置不同的动画效果。

animation:
  enable: true
  options:
    header:
    home:
    article:
    archive:

可用动画效果：

Fade: fade, fade-up, fade-down, fade-left, fade-right, fade-up-right, fade-up-left, fade-down-right, fade-down-left
Flip: flip-up, flip-down, flip-left, flip-right
Slide: slide-up, slide-down, slide-left, slide-right
Zoom: zoom-in, zoom-in-up, zoom-in-down, zoom-in-left, zoom-in-right, zoom-out, zoom-out-up, zoom-out-down, zoom-out-left, zoom-out-right

自定义样式

可以通过修改 layout.max_width 来定制主要内容区域的最大宽度，默认为 1350px。

layout:
  max_width: 1350px # 主要内容区域的最大宽度

Vendor

vendor 用于存放一些第三方资源，如 FontAwesome、Iconfont、katex、mathjax 等。

hugo-theme-reimu 的 vendor 结构非常灵活，其支持以下几种形式：

:cdn|:package@:version/:file：使用 CDN 加速，如 cdn_jsdelivr_gh|[email protected]/dist/katex.min.css，:cdn可在 vendor 中自行配置。目前自带以下 CDN 源：

cdn_jsdelivr_gh: https://cdn.jsdelivr.net/gh/ # 仅针对github加速
cdn_jsdelivr_npm: https://cdn.jsdelivr.net/npm/ # 仅针对npm加速
fastly_jsdelivr_gh: https://fastly.jsdelivr.net/gh/ # 仅针对github加速
fastly_jsdelivr_npm: https://fastly.jsdelivr.net/npm/ # 仅针对npm加速
unpkg: https://unpkg.com/ # 仅针对npm加速
webcache: https://npm.webcache.cn/ # 仅针对npm加速
local: /resources/ # 本地资源

用户可根据网络状况自行切换 CDN 源。

https://:path 开头：直接使用绝对链接，如 https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css
:path 开头：本地资源，你可以把资源放在 static 文件夹下，然后使用诸如 katex.min.css 的路径引用

此外，vendor 还支持 SRI 校验，你可以在 vendor 中使用 SHA-384 用于校验资源的完整性，如：

js:
  clipboard: # 使用 SRI 校验
    src: webcache|[email protected]/dist/clipboard.min.js
    integrity: sha384-J08i8An/QeARD9ExYpvphB8BsyOj3Gh2TSh1aLINKO3L0cMSH2dN3E22zFoXEi0Q
  lazysizes: webcache|[email protected]/lazysizes.min.js # 不使用 SRI 校验

以上两种形式均支持，建议对外部 CDN 资源使用 SRI 校验，以确保资源的完整性。

Front-matter 字段

meta	描述	类型	取值逻辑	版本
title	标题	`string`	-	Hugo 内置
date	文章创建时间	`datetime`	-	Hugo 内置
lastmod	文章最后修改时间	`datetime`	-	Hugo 内置
summary	文章摘要	`string`	-	Hugo 内置
weight	文章权重，用于排序/置顶	`int`	-	Hugo 内置
cover	文章封面	`https://example.com \| false \| rgb(255,117,117)`	-	0.0.1
categories	文章分类	`string[]`	-	0.0.1
tags	文章标签	`string[]`	-	0.0.1
description	文章描述	`string`	-	0.0.1
mermaid	是否开启 mermaid，需配合 `mermaid` 配置一起使用	`boolean`	`false`	0.0.1
math	是否开启 LaTeX，需配合 `math` 配置一起使用	`boolean`	`false`	0.0.1
link	用于文章直接指向外部链接	`string`	-	0.0.1
copyright	是否开启文章版权声明	`boolean`	不传默认走全局配置	0.0.1
sponsor	是否开启文章赞助	`boolean`	不传默认走全局配置	0.0.1
comments	是否开启文章评论	`boolean`	不传默认走全局配置	0.0.1
photos	文章照片墙	`string[]`	-	0.0.1
sidebar	文章侧边栏位置	`false \| 'left' \| 'right'`	不传默认走全局配置	0.5.0
toc	是否开启文章目录	`boolean`	不传默认走全局配置	0.7.0
outdated	文章是否过期	`boolean`	不传默认走全局配置	0.13.1
author	文章作者，用于文章版权和分享卡片	`string`	不传默认走全局配置	0.13.2
keywords	文章关键词	`string[] \| string`	不传默认走全局配置	0.13.4
banner	文章头图	`https://example.com \| false \| rgb(255,117,117)`	-	0.15.2

Name		Name	Last commit message	Last commit date
Latest commit History 375 Commits
.husky		.husky
_example		_example
archetypes		archetypes
assets		assets
config/_default		config/_default
data		data
i18n		i18n
images		images
layouts		layouts
static		static
.gitattributes		.gitattributes
.gitignore		.gitignore
.prettierrc		.prettierrc
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.en.md		README.en.md
README.md		README.md
commitlint.config.ts		commitlint.config.ts
config.toml		config.toml
go.mod		go.mod
package.json		package.json
theme.toml		theme.toml

Folders and files

Latest commit

History

Repository files navigation

hugo-theme-reimu

特性

基础功能

代码与数学

搜索与评论

统计与分析

媒体与交互功能

导航与结构

设计与自定义

安装

方式 1：Hugo Module（推荐）

方式 2：Git Submodule

使用

创建配置

主题配置

数据配置

静态资源配置

语言配置

基本结构

archives

post

about.md

friend.md

头像、封面、头图和Favicon

头像

封面

头图

Favicon

文章总结

侧边栏

侧边栏位置

TOC

社交链接

侧边栏小部件

页脚

基础信息

ICP 备案

萌国 ICP 备案 (v0.12.1+)

代码块

站内评论

站内搜索

数学公式

KaTeX

MathJax3

Mermaid

RSS

Icon

扩展功能

回到顶部

暗黑模式

站点统计

Pace 进度条

Firework 鼠标特效

PJAX

ServiceWorker

Live2D

Live2D Widgets

Reimu 鼠标指针

响应式头图

Quicklink

文章版权声明

文章过期提醒

赞助

音乐播放器（v0.4.0+）

音乐播放器位置（v0.12.1+）

纯Aplayer

Aplayer + Meting

分享链接/卡片（v0.5.0+）

首页目录卡片（v0.6.0+）

注入器（v0.6.3+）

Pangu 自动分割 （v0.7.0+）

三角徽标（v0.13.2+）

内置shortcode

friendsLink 友链卡片

postLinkCard 内链卡片 (不推荐，建议使用 link)

externalLinkCard 外链卡片 (不推荐，建议使用 link)

Pangu 自动分割（v0.7.0+）

Packages