本人是车车人,所以制作了这样一款博丽灵梦风格的 Hexo 主题,融合了 landscape、Tangyuxian 和 Shoka 三个主题
Astro 主题请参见 astro-theme-reimu
欢迎提交 ISSUE 和 PR!
- 所有的博客常规功能
- 兼容 Hexo v6+
- 响应式布局
- 代码高亮,代码粘贴
- 支持 KaTeX 展示数学公式
- 支持 Mermaid 展示流程图
- Algolia / hexo-generator-search 搜索支持
- valine / waline / twikoo / gitalk / giscus 评论系统
- valine / waline 文章阅读统计
- 不蒜子访客统计
- 支持 RSS
- 同时支持 iconfont 和 fontawesome
- 黑夜模式
- 图片懒加载
- 加载动画
- TOC
- 回到顶部
- 鼠标动画
- pjax
- ServiceWorker
- live2d
- reimu 鼠标指针
- 内部提供内链/外链/友链卡片的标签插件
- 支持文章底部版权声明
- 支持配置自定义 CDN 源
.
├── _screenshot 截图
├── _example 示例source文件夹内结构
├── _config.yml 主题配置
├── languages
├── layout
├── scripts
└── source
使用 npm
npm install hexo-theme-reimu --save
或直接克隆本仓库至 /themes
文件夹下并重命名为 reimu
git clone https://github.com/D-Sketon/hexo-theme-reimu.git
并修改 _config.yml
中的 theme
# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: reimu
基本结构
为了保证显示正确,请参考 _example
在 source
中分别建立 _data
、about
和 friend
文件夹
avatar
文件夹中存储作者头像,默认命名avatar.webp
,可在 内层_config.yml
中做如下配置
avatar: "avatar.webp" # 默认就是在avatar文件夹内寻找,请不要包含路径,否则会404
covers
文件夹中存储文章封面covers.yml
中存储文章封面 url
index.md
作为关于页面
index.md
作为友链页面,在 _data.yml
中填入友链信息即可在页面上显示对应好友卡片
封面、头图和图标
封面显示逻辑如下
- 如果文章的 Front matter 中包含 cover 的 url,则该文章头图和首页缩略图均显示该 url
---
title: Hello World
cover: https://example.com
---
- 如果文章的 Front matter 中包含 cover 为
false
,则该文章不显示头图(首页上仍然是随机图片)
---
title: Hello World
cover: false
---
- 如果文章的 Front matter 中包含 cover 为
rgb(xxx,xxx,xxx)
,则该文章头图为对应的渐变纯色(首页上仍然是随机图片)
---
title: Hello World
cover: rgb(255,117,117)
---
- 否则查找
covers
文件夹和covers.yml
,并从中随机挑选图片 - 若上述文件均不存在,则显示头图
头图保存于 themes/reimu/source/images/banner.webp
,可在内层 _config.yml
中修改
banner: "/images/banner.webp"
图标保存于 themes/reimu/source/images/favicon.ico
,可在内层 _config.yml
中修改
favicon: "/images/favicon.ico"
在文章的 Front-matter 中添加 sticky: true
---
title: Hello World
sticky: true
---
代码高亮
为保证代码块的正确显示,请保证外层 _config.yml
中为如下配置
(<7.0.0)
highlight:
enable: true
wrap: true
hljs: false
prismjs:
enable: false
(>=7.0.0)
syntax_highlighter: highlight.js
highlight:
wrap: true
hljs: false
站内评论
站内评论可以使用 Front matter 中的
comments
独立控制每篇文章是否显示评论。
当comments
为false
时不显示评论,true
或不填时根据_config_yml
的配置决定是否显示。
若基于 Valine
请参考其官方文档完成 LeanCloud
的配置,并在内层 _config_yml
中将 valine.enable
改为 true
,并填入自己的 appId
和 appKey
valine:
enable: true
appId: "your appId"
appKey: "your appKey"
若基于 Waline
请参考其官方文档完成 LeanCloud
的配置,并在内层 _config_yml
中将 waline.enable
改为 true
,并填入自己的 serverURL
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/[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 部署,并在内层 _config_yml
中将 twikoo.enable
改为 true
,并填入自己的 envId
twikoo:
enable: true
envId: # 腾讯云环境填 envId;Vercel 环境填地址(https://xxx.vercel.app)
region:
若基于 giscus,请参考文档完成仓库的配置,并在内层 _config_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
commentTheme: preferred_color_scheme
lang: zh-CN
若基于 gitalk
请参考其官方文档完成仓库的配置,并在内层 _config_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"
站内搜索
若选择 Algolia,请安装 hexo-algoliasearch
npm install hexo-algoliasearch --save
并参考其 README 完成对 Algolia
账号的配置,并在外层 _confg.yml
中添加如下配置
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
algolia_search:
enable: true
注意:搜索跳转链接为永久链接,所以请保证外层 _config.yml
中的 url
填写正确
若选择 hexo-generator-search,请安装hexo-generator-search
并参考其 README在外层 _config.yml
中添加如下配置
search:
path: search.json # 文件名必须为search.json
field: post
content: true
在内层 _config_yml
中将 generator_search.enable
改为 true
generator_search:
enable: true
数学公式
数学公式基于 Katex,请安装 hexo-renderer-markdown-it-plus
npm uninstall hexo-renderer-marked --save
npm install hexo-renderer-markdown-it-plus --save
在内层 _config_yml
中将 math.enable
改为 true
math:
enable: true
Mermaid
请安装 hexo-filter-mermaid-diagrams
npm install hexo-filter-mermaid-diagrams --save
在内层 _config_yml
中将 mermaid.enable
改为 true
mermaid:
enable: true
并在需要使用 mermaid 的文章的 front-matter 中添加 mermaid: true
---
title: Hello World
mermaid: true
---
RSS
npm install hexo-generator-feed --save
并参考其 README 在外层 _config.yml
完成对 feed
的配置
在内层 _config.yml
中填入生成的 xml
rss: atom.xml
Icon
Icon 默认使用本项目提供的 iconfont(v0.1.3+)
icon_font: 4552607_y484ez0be3f
如果想要继续使用 fontawesome 图标,请将 icon_font
设置为 false
,此时会使用 vendor
中对应的 fontawesome
fontawesome:
high_priority:
- webcache|@fortawesome/[email protected]/css/regular.min.css
- webcache|@fortawesome/[email protected]/css/solid.min.css
low_priority:
- webcache|@fortawesome/[email protected]/css/brands.min.css
- webcache|@fortawesome/[email protected]/css/v5-font-face.min.css
- webcache|@fortawesome/[email protected]/css/v4-font-face.min.css
高级功能
默认开启
firework:
enable: true
具体配置请查看 mouse-firework
默认关闭
pjax:
enable: false
pjax 在 v0.0.10 中被引入,用于那些需要添加音乐播放器等需要 SPA 的用户。但其仍然属于实验性质,引入后可能会出现诸如脚本无法执行、脚本重复执行、页面渲染混乱等 BUG。请慎重考虑!
默认关闭
service_worker:
enable: false
默认关闭
live2d:
enable: false
默认开启
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.webp"
media: "(min-width: 800px)"
默认关闭
article_copyright:
enable: false # 是否展示版权卡片?
content:
author: # true | false 版权卡片展示作者?
link: # true | false 版权卡片展示链接?
title: # true | false 版权卡片展示标题?
date: # true | false 版权卡片展示创建日期?
updated: # true | false 版权卡片展示更新日期?
license: # true | false 版权卡片展示协议?
Vendor
v0.1.0 对 vendor
进行了较大程度的重构,目前 vendor
路径的组成方式为::cdn|:package@:version/:file
,: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加速
用户可根据网络状况自行切换 CDN 源。