hugo-theme-reimu 迁移指南

本文记录了 hugo-theme-reimu 主题和 hexo-theme-reimu 主题的区别，以及如何将 hexo-theme-reimu 主题的文章迁移到 hugo-theme-reimu 主题。

Github

https://github.com/D-Sketon/hugo-theme-reimu

本文假设你已经安装了 hugo-theme-reimu 主题，并按照 指南 的创建配置文件的步骤创建了自己的配置文件。

Hexo 和 Hugo 的差异

• Hugo 不支持 Hexo 的多层级 categories，只支持一级 categories 和一级 tags
• Hugo 不支持 Hexo 的月度归档和年度归档

基础结构

hugo-theme-reimu 主题和 hexo-theme-reimu 主题的基础结构有所不同：

• 原 _config.reimu.yml 迁移到 config/_default/params.yml
• 原 _config.reimu.yml 中的 vendor 配置迁移到 data/vendor.yml 中
• 原 source/_data/covers.yml 迁移到 data/covers.yml
• 原 source/friend/_data.yml 迁移到 data/friends.yml
• 原 source/_data/avatar/avatar.webp 迁移到 static/avatar/avatar.webp

基础配置修改

hugo 里新增了如下配置：

+ mainSections: ["post"] # 指定主要的 section，指代编写文章的文件夹
+ yearFormat: "2006" # 年份格式
+ monthFormat: "2006-01" # 月份格式
+ dateFormat: "2006-01-02" # 日期格式
+ timeFormat: "2006-01-02 15:04:05" # 时间格式

+ author: D-Sketon # 原 Hexo _config.yml 里的 author
+ description: "少女祈祷中..." # 原 Hexo _config.yml 里的 description
+ subtitle: "少女祈祷中..." # 原 Hexo _config.yml 里的 subtitle

（相比于< v1.0.0 版本，v1.0.0后 hexo与hugo统一了配置）改变了 menu 配置的结构：

menu:
-  home: /
-  archives: /archives
-  about: /about
-  friend: /friend
+  - name: home
+    url: ""
+  - name: archives
+    url: "archives"
+  - name: about
+    url: "about"
+  - name: friend
+    url: "friend"

移除了 copyright 配置：

- copyright:
- # Need help choosing? Please see...
- # https://creativecommons.org/choose/
- # https://choosealicense.com/
- # You can use pug like below...
- # copyright: |-
- #   <div style="flex-direction:column;align-items: center;"><a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a>
- #   All website licensed under <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC BY 4.0</a></div>

另外，配置里所有的路径都是相对路径，不需要加上 /，如：

- banner: "/images/banner.webp"
+ banner: "images/banner.webp"

Widget

widget 移除了 archive 配置：

widgets:
-   - archive

移除了 archive_type 和 show_count 配置：

- archive_type: "monthly"
- show_count: false

favicon

现在默认使用 static/favicon.ico 作为 favicon，不再支持配置 favicon。

- favicon: "/images/favicon.ico"

Open Graph

移除了 default_og_image 配置，现在会默认使用 banner 作为默认的 Open Graph 图片。

open_graph:
  enable: true
  options:
-     default_og_image: /images/banner.webp

站内搜索

不支持本地搜索，只支持 Algolia 搜索。

- generator_search:
-   enable: false

由于无法读取到 hugo.toml，Algolia 需要增加 appID、 apiKey 和 indexName 配置：

algolia_search:
  enable: false
+   appID:
+   apiKey:
+   indexName:

数学公式

现在改为使用 Front Matter 来启用公式渲染，math.enable 配置移除。

• KaTeX 仅支持客户端渲染，所以 math.katex.autoRender 配置移除。
• MathJax3 的 options 配置需要包裹在 [] 里（排除 Hugo 内置读取配置逻辑）。

math:
-   enable: true
  katex:
    enable: true
-    autoRender: false
  mathjax:
    enable: false
-     options: { tex: {} }
+     options: [{ tex: {} }]

Mermaid

原配置移除。现在改为使用 Front Matter 来启用 Mermaid。

- mermaid:
-   enable: true # default true

RSS

Hugo 默认支持 RSS，原配置移除。

- rss: atom.xml