1.前言

  1. 博客搭建过程遇到任何问题，优先在本页面搜索，检查是否已经有该配置教程。
  2. 遇到问题可以优先在文章评论区留言，注意留言时请填写正确的邮箱以确保能收到站长的回复。
  3. 实在解决不了的问题可添加站长的微信进行交流，备注自己的个人信息。

2.语言

修改站点配置文件_config.yml，默认语言是 en 。
主题支持三种语言：

  • default(en)
  • zh-CN (简体中文)
  • zh-TW (繁体中文)

3.网站资料

修改网站各种资料，例如标题、副标题和邮箱等个人资料，请修改站点配置文件_config.yml。部分参数如下，详细参数可参考官方的配置描述。

参数 描述
title 网站标题
subtitle 描述
description 网站描述
keywords 网站的关键词。支持多个关键词
author 您的名字
language 网站使用的语言。对于简体中文用户来说，使用不同的主题可能需要设置成不同的值，请参考你的主题的文档自行设置，常见的有 zh-Hans和 zh-CN。
timezone 网站时区。Hexo 默认使用您电脑的时区。请参考 时区列表 进行设置，如 America/New_York, Japan, 和 UTC 。一般的，对于中国大陆地区可以使用 Asia/Shanghai

4.导航菜单

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8
9
10
menu:
  Home: / || fas fa-home
  Archives: /archives/ || fas fa-archive
  Tags: /tags/ || fas fa-tags
  Categories: /categories/ || fas fa-folder-open
  List||fas fa-list:
    Music: /music/ || fas fa-music
    Movie: /movies/ || fas fa-video
  Link: /link/ || fas fa-link
  About: /about/ || fas fa-heart

  • 必须是 /xxx/，后面||分开，然后写图标名，如果不想显示图标，图标名可不写

  • 若主题版本大于 v4.0.0，可以直接在子目录里添加 hide 隐藏子目录，如下面的List

1
2
3
4
5
6
7
8
9
10
menu:
  Home: / || fas fa-home
  Archives: /archives/ || fas fa-archive
  Tags: /tags/ || fas fa-tags
  Categories: /categories/ || fas fa-folder-open
  List||fas fa-list||hide:
   Music: /music/ || fas fa-music
    Movie: /movies/ || fas fa-video
  Link: /link/ || fas fa-link
  About: /about/ || fas fa-heart
  • 文字可自行更改，中英文都可以
1
2
3
4
5
6
7
8
9
10
11
menu:
  首页: / || fas fa-home
  时间轴: /archives/ || fas fa-archive
  标签: /tags/ || fas fa-tags
  分类: /categories/ || fas fa-folder-open
  清单||fa fa-heartbeat:
    音乐: /music/ || fas fa-music
    照片: /Gallery/ || fas fa-images
    电影: /movies/ || fas fa-video
  友链: /link/ || fas fa-link
  关于: /about/ || fas fa-heart

最终效果如下图所示：

image-20221029173243861

5.代码

5.1 代码高亮主题

Butterfly支持 6 种代码高亮样式：

  • darker
  • pale night
  • light
  • ocean
  • mac
  • mac light

修改主题配置文件_config.butterfly.yml。中的highlight_theme属性。

1
highlight_theme: darker

1
highlight_theme: pale night

1
highlight_theme: light

1
highlight_theme: ocean

1
highlight_theme: mac

1
highlight_theme: mac light

5.2 代码复制

修改主题配置文件_config.butterfly.yml中的highlight_copy属性，true表示可以复制。

1
highlight_copy: true

image-20221029173420960

5.3 代码框展开/关闭

修改主题配置文件_config.butterfly.yml。中的highlight_shrink属性。

1
highlight_shrink: true

在默认情况下，代码框自动展开，可设置是否所有代码框都关闭状态，点击>可展开代码。

  • true 全部代码框不展开，需点击>打开
  • false 代码框展开，有>点击按钮
  • none 不显示>按钮

image-20221029173458309

5.4 代码换行

在默认情况下，Hexo 在编译的时候不会实现代码自动换行。如果你不希望在代码块的区域里有横向滚动条的话，那么你可以考虑开启这个功能。

修改主题配置文件_config.butterfly.yml。中的code_word_wrap属性。

1
code_word_wrap: true

5.5 代码高度限制

可配置代码高度限制，超出的部分会隐藏，并显示展开按钮。

1
highlight_height_limit: false
  1. 单位是px，直接添加数字，如 200
  2. 实际限制高度为highlight_height_limit + 30 px ，多增加 30px 限制，目的是避免代码高度只超出highlight_height_limit 一点时，出现展开按钮，展开没内容。
  3. 不适用于隐藏后的代码块（ css 设置 display: none）。

image-20221029173522172

6.社交图标

Butterfly支持font-awesome v6图标。

书写格式：图标名：url || 描述性文字。

1
2
3
social:
  fab fa-github: https://github.com/xxxxx || Github
  fas fa-envelope: mailto:xxxxxx@gmail.com || Email

image-20221029173631192

7.顶部图

如果不要显示顶部图，可直接配置 disable_top_img: true。

配置 解释
index_img 主页的 top_img
default_top_img 默认的 top_img，当页面的 top_img 没有配置时，会显示 default_top_img
archive_img 归档页面的 top_img
tag_img tag子页面 的 默认 top_img
tag_per_img tag子页面的 top_img，可配置每个 tag 的 top_img
category_img category 子页面 的 默认 top_img
category_per_img category 子页面的 top_img，可配置每个 category 的 top_img

修改主题配置文件_config.butterfly.yml

1
index_img: xxx.png

其它页面 （tags/categories/自建页面）和文章页的top_img，请到对应的 md 页面设置front-matter中的top_img。

8.文章置顶与封面

  1. 你可以直接在文章的front-matter区域里添加sticky: 1属性来把这篇文章置顶。数值越大，置顶的优先级越大。

  2. 文章的markdown文档上，在Front-matter添加cover，并填上要显示的图片地址。如果不配置cover，可以设置显示默认的cover；如果不想在首页显示cover，可以设置为false。
    修改主题配置文件_config.butterfly.yml。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    cover:
      
      index_enable: true
      aside_enable: true
      archives_enable: true
      
      
      position: both
      
      default_cover:

    当配置多张图片时，会随机选择一张作为cover，此时写法应为：

    1
    2
    3
    4
    default_cover:
      - https://cdn.jsdelivr.net/gh/jerryc127/CDN@latest/cover/default_bg.png
      - https://cdn.jsdelivr.net/gh/jerryc127/CDN@latest/cover/default_bg2.png
      - https://cdn.jsdelivr.net/gh/jerryc127/CDN@latest/cover/default_bg3.png

image-20221029173703144

9.文章页相关配置

9.1 文章meta显示

post_meta这个属性用于显示文章的相关信息的，修改主题配置文件_config.butterfly.yml。

1
2
3
4
5
6
7
8
9
10
11
12
13
post_meta:
  page:
    date_type: both 
    date_format: relative 
    categories: true 
    tags: true 
    label: true 
  post:
    date_type: both 
    date_format: relative 
    categories: true 
    tags: true 
    label: true

9.2 文章版权和协议许可

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
post_copyright:
  enable: true
  decode: false
  author_href:
  license: CC BY-NC-SA 4.0
  license_url: https://creativecommons.org/licenses/by-nc-sa/4.0/

由于Hexo 4.1开始，默认对网址进行解码，以至于如果是中文网址，会被解码，可设置decode: true来显示中文网址。如果有文章（例如：转载文章）不需要显示版权，可以在文章页Front-matter中单独设置。

1
copyright: false

从v3.0.0开始，支持对单独文章设置版权信息，可以在文章Front-matter单独设置。

1
2
3
4
5
post_copyright:
copyright_author: xxxx
copyright_author_href: https://xxxxxx.com
copyright_url: https://xxxxxx.com
copyright_info: 此文章版权归xxxxx所有，如有转载，请註明来自原作者

image-20221029173741784

9.3 文章打赏

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8
9
reward:
  enable: false
  QR_code:
    - img: /img/wechat.jpg
      link:
      text: wechat
    - img: /img/alipay.jpg
      link:
      text: alipay

9.4 文章目录TOC

修改主题配置文件_config.butterfly.yml。

1
2
3
4
5
6
toc:
  post: true 
  page: false 
  number: true 
  expand: false
  style_simple: false

image-20221029173812311

9.5 相关文章推荐

相关文章推荐的原理是根据文章tags的比重来推荐，修改主题配置文件_config.butterfly.yml。

1
2
3
4
related_post:
  enable: true
  limit: 6 
  date_type: created

9.6 文章锚点

开启文章锚点后，当你在文章页进行滚动时，文章链接会根据标题ID进行替换。

注意: 每替换一次，会留下一个歷史记录。所以如果一篇文章有很多锚点的话，网页的歷史记录会很多。

修改主题配置文件_config.butterfly.yml。

1
2
3


anchor: true

9.7 文章过期提醒

可设置是否显示文章过期提醒，以更新时间为基准。

1
2
3
4
5
6
7
8

noticeOutdate:
  enable: true
  style: flat 
  limit_day: 365 
  position: top 
  message_prev: It has been 
  message_next: days since the last update, the content of the article may be outdated.

9.8 文章分页按钮

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6





post_pagination: false

image-20221029173929409

10.头像

1
2
3
avatar:
  img: /assets/head.jpg
  effect: false

image-20221028141401289

11.文章内容复制相关配置

1
2
3
4
5
6
7


copy:
  enable: true
  copyright:
    enable: true
    limit_count: 50

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
footer:
  owner:
    enable: true
    since: 2022
  custom_text:
  copyright: false

可以参考tzy大佬的的custom_text填写示例：

1
custom_text: I wish you to become your own sun, no need to rely on who's light.<p><a target="_blank" href="https://hexo.io/"><img src="https://img.shields.io/badge/Frame-Hexo-blue?style=flat&logo=hexo" title="博客框架为Hexo"></a>&nbsp;<a target="_blank" href="https://butterfly.js.org/"><img src="https://img.shields.io/badge/Theme-Butterfly-6513df?style=flat&logo=bitdefender" title="主题采用butterfly"></a>&nbsp;<a target="_blank" href="https://www.jsdelivr.com/"><img src="https://img.shields.io/badge/CDN-jsDelivr-orange?style=flat&logo=jsDelivr" title="本站使用JsDelivr为静态资源提供CDN加速"></a> &nbsp;<a target="_blank" href="https://vercel.com/ "><img src="https://img.shields.io/badge/Hosted-Vervel-brightgreen?style=flat&logo=Vercel" title="本站采用双线部署，默认线路托管于Vercel"></a>&nbsp;<a target="_blank" href="https://vercel.com/ "><img src="https://img.shields.io/badge/Hosted-Coding-0cedbe?style=flat&logo=Codio" title="本站采用双线部署，联通线路托管于Coding"></a>&nbsp;<a target="_blank" href="https://github.com/"><img src="https://img.shields.io/badge/Source-Github-d021d6?style=flat&logo=GitHub" title="本站项目由Gtihub托管"></a>&nbsp;<a target="_blank" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://img.shields.io/badge/Copyright-BY--NC--SA%204.0-d42328?style=flat&logo=Claris" title="本站采用知识共享署名-非商业性使用-相同方式共享4.0国际许可协议进行许可"></a></p>

对于部分人需要写 ICP 的，也可以写在custom_text里。

1
custom_text: <a href="icp链接"><img class="icp-icon" src="icp图片"><span>备案号：xxxxxx</span></a>

13.右下角按钮

13.1 简繁转换

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
translate:
  enable: false
  
  default: 繁
  
  
  defaultEncoding: 2
  
  translateDelay: 0
  
  msgToTraditionalChinese: '繁'
  
  msgToSimplifiedChinese: '簡'

13.2 夜间模式

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8
9
10

darkmode:
  enable: false
  
  button: true
  
  
  
  
  autoChangeMode: false

v2.0.0 开始增加一个选项，可开启自动切换light mode 和 dark mode。

  • autoChangeMode: 1 跟随系统而变化，不支持的浏览器/系统将按照时间晚上6点到早上6点之间切换为 dark mode。
  • autoChangeMode: 2只按照时间 晚上6点到早上6点之间切换为 dark mode,其余时间为light mode。
  • autoChangeMode: false 取消自动切换。

13.3 阅读模式

阅读模式下会去掉除文章外的内容，避免干扰阅读。只会出现在文章页面，右下角会有阅读模式按钮。

修改主题配置文件_config.butterfly.yml

1
readmode: true

14.侧边栏设置

14.1 排版

可自行决定哪个项目需要显示，可决定位置，也可以设置不显示侧边栏。

修改主题配置文件_config.butterfly.yml，下面是本人博客的配置项可以参考

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
aside:
  enable: true
  hide: false
  button: true
  mobile: true 
  position: right 
  display:
    archive: true
    tag: true
    category: true
  card_author:
    enable: true
    description:
    button:
      enable: true
      icon: 
      text: 🛴前往小家...
      link: https://github.com/fomalhaut1998
  card_announcement:
    enable: true
    content: <center>主域名：<br><a href="https://www.fomal.cc"><b><font color="#5ea6e5">fomal.cc</font></b></a>&nbsp;|&nbsp;<a href="https://www.fomal.cn"><b><font color="#5ea6e5">fomal.cn</font></b></a><br>备用域名：<br><a href="https://blog.fomal.cc"><b><font color="#5ea6e5">blog.fomal.cc</font></b></a><br><a href="https://aa.fomal.cc"><b><font color="#5ea6e5">aa.fomal.cc</font></b></a><br><a href="https://bb.fomal.cc"><b><font color="#5ea6e5">bb.fomal.cc</font></b></a><br><a href="mailto:admin@fomal.cn">📬：<b><font color="#a591e0">admin@fomal.cn</font></b></a></center>
  card_recent_post:
    enable: false
    limit: 3 
    sort: date 
    sort_order: 
  card_categories:
    enable: false
    limit: 8 
    expand: none 
    sort_order: 
  card_tags:
    enable: false
    limit: 20 
    color: true
    sort_order: 
  card_archives:
    enable: false
    type: monthly 
    format: MMMM YYYY 
    order: -1 
    limit: 8 
    sort_order: 
  card_webinfo:
    enable: true
    post_count: true
    last_push_date: true
    sort_order: 
  card_weibo:
    enable: true

14.2 访问人数(UV 和 PV)

修改主题配置文件_config.butterfly.yml

1
2
3
4
busuanzi:
  site_uv: true  
  site_pv: true  
  page_pv: true

14.3 运行时间

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8


runtimeshow:
  enable: false
  publish_date: 8/9/2022 00:00:00

14.4 最新评论

v3.1.0 以上支持。如果未配置任何评论，前先不要开启该功能。

最新评论只会在刷新时才会去读取，并不会实时变化。
由于 API 有 访问次数限制，为了避免调用太多，主题默认存取期限为 10 分鐘。也就是説，调用后资料会存在 localStorage 里，10分鐘内刷新网站只会去 localStorage 读取资料。 10 分鐘期限一过，刷新页面时才会去调取 API 读取新的数据。（3.6.0 新增了 storage 配置，可自行配置缓存时间）。

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7

newest_comments:
  enable: true
  sort_order: 
  limit: 6  
  storage: 10 
  avatar: true

15.网站背景

修改主题配置文件_config.butterfly.yml

1
2
3
4



background: url(https://source.fomal.cc/img/dm1.webp)

如果你的网站根目录不是'/'，使用本地图片时，需加上你的根目录。
例如：网站是 https://yoursite.com/blog，引用一张img/xx.png图片，则设置background为 url(/blog/img/xx.png)

16.打字效果

详见：activate-power-mode

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7


activate_power_mode:
  enable: false
  colorful: true 
  shake: true 
  mobile: false

修改主题配置文件_config.butterfly.yml

1
2

footer_bg: true
  • 留空/false：显示默认的颜色
  • 图片链接：显示所配置的图片
  • 颜色包括HEX值 - #0000FF | RGB值 - rgb(0,0,255) | 颜色单词 - orange | 渐变色 - linear-gradient( 135deg, #E2B0FF 10%, #9F44D3 100%)：对应的颜色
  • true：显示跟 top_img 一样

18.背景特效

可设置每次刷新更换彩带，或者每次点击更换彩带。详细配置可查看canvas_ribbon

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
canvas_ribbon:
  enable: false
  size: 150
  alpha: 0.6
  zIndex: -1
  click_to_change: false  
  mobile: false

好看的彩带背景，会飘动。
修改主题配置文件_config.butterfly.yml

1
2
3
canvas_fluttering_ribbon:
  enable: true
  mobile: true

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
canvas_nest:
  enable: true
  color: '0,0,255' 
  opacity: 0.7 
  zIndex: -1 
  count: 99 
  mobile: false

19.鼠标点击效果

zIndex建议只在-1和9999上选。
-1 代表烟火效果在底部。
9999 代表烟火效果在前面。

修改主题配置文件_config.butterfly.yml

1
2
3
4
fireworks:
  enable: true
  zIndex: 9999 
  mobile: false

修改主题配置文件_config.butterfly.yml

1
2
3
4

click_heart:
  enable: true
  mobile: false

修改主题配置文件_config.butterfly.yml

1
2
3
4
5
6
7
8
9
10

ClickShowText:
  enable: false
  text:
    - I
    - LOVE
    - YOU
  fontSize: 15px
  random: false 
  mobile: false

20.自定义字体和字体大小

20.1 全局字体

修改主题配置文件_config.butterfly.yml中的font-family属性即可，如不需要配置，请留空。

1
2
3
4
5
6
7
8
9
10
11


font:
  global-font-size: '15px'
  code-font-size: '14px'
  
  
  font-family: var(--global-font), Consolas_1, -apple-system, 'Quicksand', 'Nimbus Roman No9 L', 'PingFang SC', 'Hiragino Sans GB', 'Noto Serif SC', 'Microsoft Yahei', 'WenQuanYi Micro Hei', 'ST Heiti', sans-serif;
  
  
  code-font-family: Consolas_1, var(--global-font), "Microsoft YaHei", Menlo, "PingFang SC", "Microsoft JhengHei", sans-serif

20.2 Blog 标题字体

修改主题配置文件_config.butterfly.yml中的blog_title_font属性即可，如不需要配置，请留空。
如不需要使用网络字体，只需要把font_link留空就行。

1
2
3
4
5
6
7




blog_title_font:
  font_link: 
  font-family: var(--global-font)

21.网站副标题

可设置主页中显示的网站副标题或者喜欢的座右铭。

修改主题配置文件_config.butterfly.yml中的subtitle

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

subtitle:
  enable: true
  
  effect: true
  
  loop: true
  
  
  
  
  
  
  source: false
  
  sub:
    - "Welcome to Fomalhaut🥝のTiny Home!🤣🤣🤣"
    - "Hope you have a nice day!🍭🍭🍭"

预览效果见本站主页：Fomalhaut🥝

22.页面加载动画preloader

当进入网页时，因为加载速度的问题，可能会导致top_img图片出现断层显示，或者网页加载不全而出现等待时间，开启preloader后，会显示加载动画，等页面加载完，加载动画会消失。

1
2

preloader: true

23.字数统计

注意必须要安装依赖才能设置为true，否则会报错！

  1. 安装插件：在你的博客根目录，打开cmd命令窗口执行npm install hexo-wordcount --save。
  2. 开启配置：修改主题配置文件_config.butterfly.yml中的wordcount。
1
2
3
4
5
wordcount:
  enable: true
  post_wordcount: true
  min2read: true
  total_wordcount: true

24.图片大图查看模式

只能开启一个。
如果你并不想为某张图片添加大图查看模式，你可以使用 html 格式引用图片，并为图片添加 no-lightbox class 名，例如：<img src="xxxx.jpg" class="no-lightbox">。

修改主题配置文件_config.butterfly.yml中fancybox属性

1
2

fancybox: true

修改主题配置文件_config.butterfly.yml中medium_zoom属性

1
medium_zoom: true

25.Pjax

当用户点击链接，通过 ajax 更新页面需要变化的部分，然后使用 HTML5 的 pushState 修改浏览器的 URL 地址。这样可以不用重复加载相同的资源（css/js）， 从而提升网页的加载速度。

1
2
3
4
5
6
7
8
9
10
11



pjax: 
  enable: true
  
  
  
  exclude: 
    - /music/
    - /no-pjax/

注意：使用 pjax 后，一些自己DIY的js可能会无效，跳转页面时需要重新调用（例如朋友圈、说说等），具体请参考Pjax文档。

26.Inject

如想添加额外的 js/css/meta 等等东西，可以在 Inject 里添加，head(</body>标签之前)， bottom(</html>标签之前)。

1
2
3
4
5
6
7
8



inject:
  head:
    - <link rel="stylesheet" href="/xxx.css">
  bottom:
    - <script src="xxxx"></script>

27.本地搜索系统

  1. 安装依赖：前往博客根目录，打开cmd命令窗口执行npm install hexo-generator-search --save。

    1
    npm install hexo-generator-search --save

  2. 注入配置：修改站点配置文件_config.yml，添加如下代码：

    1
    2
    3
    4
    search:
      path: search.xml
      field: post
      content: true

  3. 主题中开启搜索：在主题配置文件_config.butterfly.yml中修改以下内容：

    1
    2
    3
    local_search:
    -  enable: false
    +  enable: true

  4. 重新编译运行，即可看到效果：前往博客根目录，打开cmd命令窗口依次执行如下命令：

    1
    2
    hexo cl && hexo generate
    hexo s -p 8000

    详情可参考 hexo-generator-search

image-20221029174043726