hexo-theme-reimu

NPM License NPM Version GitHub Repo stars wakatime

💘 博麗 霊夢 💘

演示网站 | 开发日志

简体中文 | English

[!WARNING]
v1.0.0 以下版本已经废弃，请尽快升级到 v1.0.0 以上版本

本人是车车人，所以制作了这样一款博丽灵梦风格的 Hexo 主题，融合了 landscape、Tangyuxian 和 Shoka 三个主题

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

欢迎提交 ISSUE 和 PR！

特性

基础功能

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

代码与数学

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

搜索与评论

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

统计与分析

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

媒体与交互功能

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

导航与结构

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

设计与自定义

  • 🎨 图标支持：
    • Iconfont
    • FontAwesome
  • 🔗 内置标签插件：
    • 内部链接
    • 外部链接
    • 友情链接
  • 🎨 自定义容器
  • ©️ 文章版权声明
  • 🌐 自定义 CDN 源配置
  • 🎨 分享卡片功能

安装

纯小白可以直接使用 reimu-template。其中预先安装了 hexo, hexo-theme-reimu 和其他功能包，只需 克隆仓库-安装依赖-修改配置 即可获得一个基本的博客！

使用 npm

1
npm install hexo-theme-reimu --save

或直接克隆本仓库至 /themes 文件夹下并重命名为 reimu

1
git clone https://github.com/D-Sketon/hexo-theme-reimu.git

并修改 _config.yml 中的 theme

1
2
3
4
# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: reimu

使用

基本结构

基本结构

为了保证显示正确，请参考 _example 在 source 中分别建立 _data、about 和 friend 文件夹 （注意：是博客根目录下的 source 文件夹，而不是主题中的 source ！）

_data

  • avatar 文件夹中存储作者头像，默认命名 avatar.webp，可在内层 _config.yml 中做如下配置
1
avatar: "avatar.webp" # 默认就是在avatar文件夹内寻找，请不要包含路径，否则会404
  • covers 文件夹中存储文章封面
  • covers.yml 中存储文章封面 url

about

index.md 作为关于页面

friend

index.md 作为友链页面，在 _data.yml 中填入友链信息即可在页面上显示对应好友卡片

封面、头图和favicon

封面、头图和 favicon

封面

封面显示逻辑如下

  • 如果文章的 Front matter 中包含 cover 的 url，则该文章头图和首页缩略图均显示该 url
1
2
3
4
---
title: Hello World
cover: https://example.com
---
  • 如果文章的 Front matter 中包含 cover 为 false，则该文章不显示头图（首页上仍然是随机图片）
1
2
3
4
---
title: Hello World
cover: false
---
  • 如果文章的 Front matter 中包含 cover 为 rgb(xxx,xxx,xxx)，则该文章头图为对应的渐变纯色（首页上仍然是随机图片）
1
2
3
4
---
title: Hello World
cover: rgb(255,117,117)
---
  • 否则查找 covers 文件夹和 covers.yml，并从中随机挑选图片
  • 若上述文件均不存在，则显示头图

头图

头图保存于 themes/reimu/source/images/banner.webp，可在内层 _config.yml 中修改

1
banner: "/images/banner.webp"

favicon

favicon 保存于 themes/reimu/source/images/favicon.ico，可在内层 _config.yml 中修改

1
favicon: "/images/favicon.ico"

置顶

在文章的 Front-matter 中添加 sticky: true

1
2
3
4
---
title: Hello World
sticky: true
---
代码块

代码块

为保证代码块的正确显示，请保证外层 _config.yml 中为如下配置
(Hexo <7.0.0)

1
2
3
4
5
6
highlight:
  enable: true
  wrap: true
  hljs: false
prismjs:
  enable: false

(Hexo >=7.0.0)

1
2
3
4
syntax_highlighter: highlight.js
highlight:
  wrap: true
  hljs: false

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

1
2
3
4
5
6
7
clipboard:
  success: 复制成功(*^▽^*)
  fail: 复制失败 (ﾟ⊿ﾟ)ﾂ
  copyright:
    enable: false
    count: 50 # 大于多少字符添加版权声明
    content: 本文版权：本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！

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

1
2
code_block:
  expand: true # true | false | number
站内评论

站内评论

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

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

1
2
3
4
valine:
  enable: true
  appId: "your appId"
  appKey: "your appKey"

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
waline:
  enable: true
  serverURL: "your server url"
  lang: zh-CN
  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/emojis@1.2.0/weibo
    - https://unpkg.com/@waline/emojis@1.2.0/alus
    - https://unpkg.com/@waline/emojis@1.2.0/bilibili
    - https://unpkg.com/@waline/emojis@1.2.0/qq
    - https://unpkg.com/@waline/emojis@1.2.0/tieba
    - https://unpkg.com/@waline/emojis@1.2.0/tw-emoji
  meta:
    - nick
    - mail
    - link
  requiredMeta:
    - nick
    - mail
  wordLimit: 0
  pageSize: 10
  pageview: true

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
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
  lang: zh-CN

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

1
2
3
4
5
6
7
8
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 加密路径
站内搜索

站内搜索

若选择 Algolia，请安装 hexo-algoliasearch

1
npm install hexo-algoliasearch --save

并参考其 README 完成对 Algolia 账号的配置，并在外层 _config.yml 中添加如下配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
algolia:
  appId: "your applicationID"
  apiKey: "your apiKey"
  adminApiKey: "your adminApiKey"
  indexName: "your indexName"
  chunkSize: 5000
  fields:
    - content:strip:truncate,0,500
    - excerpt:strip
    - gallery
    - permalink
    - photos
    - slug
    - tags
    - title

在内层 _config.yml 中将 algolia_search.enable 改为 true

1
2
algolia_search:
  enable: true

注意：搜索跳转链接为永久链接，所以请保证外层 _config.yml 中的 url 填写正确

若选择 hexo-generator-search，请安装hexo-generator-search

并参考其 README在外层 _config.yml 中添加如下配置

1
2
3
4
search:
  path: search.json # 文件名必须为search.json
  field: post
  content: true

在内层 _config.yml 中将 generator_search.enable 改为 true

1
2
generator_search:
  enable: true
数学公式

数学公式

请安装 @reimujs/hexo-renderer-markdown-it-plus

1
2
npm uninstall hexo-renderer-marked --save
npm install @reimujs/hexo-renderer-markdown-it-plus --save

默认关闭，在内层 _config.yml 中将 math.enable 改为 true 可以开启数学公式支持

注意不要同时开启 KaTeX 和 MathJax3

KaTeX

如果想要基于服务端渲染，在内层 _config.yml 中将 math.katex.enable 改为 true

1
2
3
4
5
math:
  enable: true
  katex:
    enable: true
    autoRender: false

如果想要基于客户端渲染，在内层 _config.yml 中将 math.katex.enable 改为 true，并将 autoRender 也改为 true

1
2
3
4
5
math:
  enable: true
  katex:
    enable: true
    autoRender: true

在外层 _config.yml 中添加如下配置

1
2
markdown_it_plus:
  rawLaTeX: true

MathJax3

如果想要使用 MathJax3，请在内层 _config.yml 中将 math.mathjax.enable 改为 true

1
2
3
4
5
math:
  enable: true
  mathjax:
    enable: true
    options: # MathJax 配置

在外层 _config.yml 中添加如下配置

1
2
markdown_it_plus:
  rawLaTeX: true
Mermaid 流程图

Mermaid 流程图

请安装 hexo-filter-mermaid-diagrams

1
npm install hexo-filter-mermaid-diagrams --save

在内层 _config.yml 中将 mermaid.enable 改为 true

1
2
mermaid:
  enable: true

并在需要使用 mermaid 的文章的 front-matter 中添加 mermaid: true

1
2
3
4
---
title: Hello World
mermaid: true
---
RSS

RSS

请安装 hexo-generator-feed

1
npm install hexo-generator-feed --save

并参考其 README 在外层 _config.yml 完成对 feed 的配置
在内层 _config.yml 中填入生成的 xml

1
rss: atom.xml
i18n

i18n

本主题默认提供 en、zh-CN、zh-TW 和 ja 四种语言，可以在外层 _config.yml 中修改 language 来切换语言

1
language: zh-CN

以下为实验性功能，可能会有 BUG

v1.4.0+ 实验性地引入了 hexo-generator-i18n 并提供了多语言切换功能，可以在内层 _config.yml 中配置 i18n 来添加自定义语言，其配置方式可参考 hexo-generator-i18n：

1
2
3
4
5
i18n:
  enable: false # false | true
  type: [page, post]
  generator: [archive, category, tag, index]
  languages: [zh-CN, en] # 语言列表，第一个为默认语言

对于 post 的多语言支持，可以在 Front-matter 中添加 lang 来指定除默认语言外的其他语言（默认语言不需要添加）

1
lang: en

以上会生成 /en/:permalink 的页面

对于 page 的多语言支持，可直接在 source 文件夹下新建对应语言的文件夹，并将 index.md 放入其中，如 source/en/about/index.md。这会生成 /en/about 的页面

Icon

Icon

Icon 默认使用本主题提供的 iconfont（v0.1.3+）

1
icon_font: 4552607_0khxww3tj3q9

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

1
2
3
4
5
6
7
8
fontawesome:
  high_priority:
    - webcache|@fortawesome/fontawesome-free@6.5.1/css/regular.min.css
    - webcache|@fortawesome/fontawesome-free@6.5.1/css/solid.min.css
  low_priority:
    - webcache|@fortawesome/fontawesome-free@6.5.1/css/brands.min.css
    - webcache|@fortawesome/fontawesome-free@6.5.1/css/v5-font-face.min.css
    - webcache|@fortawesome/fontawesome-free@6.5.1/css/v4-font-face.min.css
扩展功能

扩展功能

暗黑模式

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

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

Pace 进度条

默认开启

1
2
pace:
  enable: true

Firework 鼠标特效

默认开启

1
2
firework:
  enable: true

具体配置请查看 mouse-firework

PJAX

默认关闭

1
2
pjax:
  enable: false

PJAX 在 v0.0.10 中被引入，用于那些需要添加音乐播放器等需要 SPA 的用户。经过一段时间的迭代后已基本上稳定，但引入后仍然可能会出现诸如脚本无法执行、脚本重复执行、页面渲染混乱等 BUG。请慎重考虑！

PJAX 无法与 relative_link: true 配合使用！

ServiceWorker

默认关闭

1
2
service_worker:
  enable: false

Live2D

默认关闭

1
2
3
live2d:
  enable: false
  position: left # left | right

Live2D Widgets

默认关闭

1
2
3
live2d_widgets:
  enable: false
  position: left # left | right

Reimu 鼠标指针

默认开启

1
2
3
4
5
6
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

响应式头图（v0.2.0+）

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

1
2
3
4
5
6
7
8
9
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.webp"
    media: "(min-width: 800px)"

Quicklink（v0.2.3+）

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

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

文章版权声明（v0.2.0+）

默认关闭

1
2
3
4
5
6
7
8
9
article_copyright:
enable: false # 是否展示版权卡片？
content:
  author: # true | false 版权卡片展示作者？
  link: # true | false 版权卡片展示链接？
  title: # true | false 版权卡片展示标题？
  date: # true | false 版权卡片展示创建日期？
  updated: # true | false 版权卡片展示更新日期？
  license: # true | false 版权卡片展示协议？

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

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

文章过期提醒（v0.2.4+）

默认关闭

1
2
3
4
outdate:
  enable: false
  daysAgo: 180 # 多少天前的文章算过期
  message: 本文最后更新于 {time}，请注意文中内容可能已经发生变化。

赞助（v0.3.2+）

默认关闭

1
2
3
4
5
6
7
8
9
10
sponsor:
  enable: false # 是否展示赞助二维码？
  tip: 请作者喝杯咖啡吧！ # 赞助提示
  icon:
    url: "../images/taichi.png" # 赞助图标，相对于 css/style.css 的路径，所以需要向上一级才能找到 images 文件夹
    rotate: true # 是否旋转图标
    mask: true # 是否将图片作为遮罩（即只显示 png 图片的轮廓）
  qr:
    - name: 支付宝 # 二维码名称
      src: "/sponsor/alipay.jpg" # 二维码路径，请自行填写

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

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

首页目录卡片（v1.0.0+）

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

1
2
3
4
5
6
7
home_categories:
  enable: false # 是否展示首页目录卡片？
  content:
    - categories: # 目录名称，格式和 front-matter 中的 categories 一致，可以为字符串（单级分类）或数组（多级分类）
      cover: # 卡片封面，不填则使用随机封面
    - categories:
      cover:

音乐播放器（v1.2.0+）

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

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

纯Aplayer

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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:

分享链接/卡片（v1.3.0+）

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

1
2
3
4
5
6
7
8
share:
  # - facebook
  # - twitter
  # - linkedin
  # - reddit
  # - weibo
  # - qq
  # - weixin

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

内置卡片标签插件

内置卡片标签插件

1
{% friendsLink path %}

第一个参数 path 表示友链 yaml 的路径

postLinkCard 内链卡片

1
{% postLinkCard slug [cover]|"auto" [escape] %}

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

slug 的生成算法：https://github.com/hexojs/hexo-util/blob/master/lib/slugize.ts
简单来说就是去除文章标题的不可见字符，把文章的标题中的特殊字符 \s~!@#$%^&*()\-_+=[]{}|\;:"'<>,.?/ 全换成分隔符 -，合并连续分隔符并去除首尾分隔符

externalLinkCard 外链卡片

1
{% externalLinkCard title link [cover]|"auto" %}

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

自定义容器

自定义容器

本主题提供了类似 vitepress 的自定义容器功能，使用前需要安装 @reimujs/hexo-renderer-markdown-it-plus，并在内层 _config.yml 中将 markdown.container 改为 true

1
2
markdown:
  container: true

使用方法如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: danger STOP
Danger zone, do not proceed
:::

::: details
This is a details block.
:::
自定义主题

hexo-theme-reimu 主题支持高度的自定义，你可以通过修改 _config.yml 来定制你的主题。

定制主题颜色

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

变量文件位于 source/css/_variables.styl，你可以在这个文件中找到所有的 CSS 变量，但其实只需要修改以下伪类下的变量即可：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
:root
  --red-0: hsl(0, 100%, 50%)
  --red-1: hsl(0, 100%, 66%)
  --red-2: hsl(0, 100%, 74%)
  --red-3: hsl(0, 100%, 84%)
  --red-4: hsl(0, 100%, 91%)
  --red-5: hsl(0, 100%, 95%)
  --red-5-5: hsl(0, 100%, 96%)
  d-6: hsl(0, 100%, 98%)

  --color-red-6-shadow: hsla(0, 100%, 65%, 0.6)
  --color-red-3-shadow: hsla(0, 100%, 65%, 0.3)


[data-theme="dark"]
  root
    --red-4: hsla(0, 100%, 91%, 0.5)
    --red-5: hsla(0, 100%, 95%, 0.2)
    --red-5-5: hsla(0, 100%, 96%, 0.1)
    --red-6: hsla(0, 100%, 98%, 0.2)

自定义字体

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

1
2
3
4
5
6
7
8
9
# https://fonts.google.com/
font:
  article:
    - Mulish
    - Noto Serif SC
  code:
    # - Ubuntu Mono
    # - Source Code Pro
    # - JetBrains Mono

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

1
2
3
4
5
6
7
8
9
10
11
local_font:
  article:
    - "-apple-system"
    - PingFang SC
    - Microsoft YaHei
    - sans-serif
  code:
    - Menlo
    - Monaco
    - Consolas
    - monospace

定制图标

v1.0.0 经过大量重构，向用户暴露了许多配置用于改变原有的图标

头部 / 侧边栏图标

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

1
2
3
4
5
6
7
8
9
10
11
12
13
menu:
  - name: home
    url: /
    icon: # 不填默认使用太极图标
  - name: archives
    url: /archives
    icon: f0c1 # 你可以填写一个十六进制的数字来自定义 icon，支持 fontawesome 和 icon font
  - name: about
    url: /about
    icon:
  - name: friend
    url: /friend
    icon:
底部 / 回到顶部 / 赞助图标

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

  • url 为图标的路径，相对于 css/style.css 的路径，所以需要向上一级才能找到 images 文件夹。
  • rotate 为是否旋转图标，默认为 true。
  • mask 是否将图片作为遮罩（即只显示 png 图片的轮廓），默认为 true。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
footer:
  icon:
    url: "../images/taichi.png" # 相对于 css/style.css 的路径，所以需要向上一级才能找到 images 文件夹
    rotate: true
    mask: true

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

sponsor:
  icon:
    url: "../images/taichi.png"
    rotate: true
    mask: true
加载图标

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

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

1
2
3
4
preloader:
  enable: true
  text: 少女祈祷中...
  icon: # 不填默认使用内链的svg（保证首屏加载速度），你可以填入一个链接来自定义加载图标，如 '/images/taichi.png'
锚点图标

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

1
anchor_icon: # 不填默认使用 # 图标
鼠标图标（v1.3.0+）

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

1
2
3
4
5
6
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
Vendor

Vendor

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

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

  • :cdn|:package@:version/:file：使用 CDN 加速，如 cdn_jsdelivr_gh|katex@0.13.11/dist/katex.min.css，:cdn可在 vendor 中自行配置。目前自带以下 CDN 源：
    1
    2
    3
    4
    5
    6
    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加速
    用户可根据网络状况自行切换 CDN 源。
  • https:// 开头：直接使用绝对链接，如 https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css
  • / 开头：本地资源，你可以把资源放在 source 文件夹下和 _posts 同级，然后使用诸如 /katex.min.css 的路径引用

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

1
2
3
4
5
js:
  clipboard: # 使用 SRI 校验
    src: webcache|clipboard@2.0.11/dist/clipboard.min.js
    integrity: sha384-J08i8An/QeARD9ExYpvphB8BsyOj3Gh2TSh1aLINKO3L0cMSH2dN3E22zFoXEi0Q
  lazysizes: webcache|lazysizes@5.3.2/lazysizes.min.js # 不使用 SRI 校验

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

贡献者

许可

MIT