Butterfly 安装文档(三) 主题配置-1
📖 本教程更新于 2022 年 08 月 18 日,教程的内容针对最新稳定版而更新(如果你是旧版,教程会有些出入,请留意)
🦋 Butterfly 已经更新到 4.4.0
你可以通过右下角的 简 按钮切换为简体显示
语言
修改站点配置文件 _config.yml
默认语言是 en
主题支持三种语言
- default(en)
- zh-CN (简体中文)
- zh-TW (繁体中文)
网站资料
修改网站各种资料,例如标题、副标题和邮箱等个人资料,请修改博客根目录的_config.yml
导航菜单
修改 主题配置文件
1 | Home: / || fas fa-home |
必须是 /xxx/
,后面||
分开,然后写图标名。
如果不希望显示图标,图标名可不写。
默认子目录是展开的,如果你想要隐藏,在子目录里添加 hide
。
1 | List||fas fa-list||hide: |
注意: 导航的文字可自行更改
例如:
1 | menu: |
代码
代码块中的所有功能只适用于 Hexo 自带的代码渲染
如果使用第三方的渲染器,不一定会有效
代码高亮主题
Butterfly
支持6种代码高亮样式:
- darker
- pale night
- light
- ocean
- mac
- mac light
修改 主题配置文件
1 | highlight_theme: light |
darker
pale night
light
ocean
mac
mac light
代码複制
主题支持代码複制功能
修改 主题配置文件
1 | highlight_copy: true |
代码框展开/关闭
在默认情况下,代码框自动展开,可设置是否所有代码框都关闭状态,点击>
可展开代码
- true 全部代码框不展开,需点击
>
打开 - false 代码框展开,有
>
点击按钮 - none 不显示
>
按钮
修改 主题配置文件
1 | highlight_shrink: true #代码框不展开,需点击 '>' 打开 |
你也可以在post/page页对应的markdown文件front-matter添加highlight_shrink来独立配置。
当主题配置文件中的 highlight_shrink
设为true时,可在front-matter添加highlight_shrink: false
来单独配置文章展开代码框。
当主题配置文件中的 highlight_shrink
设为false时,可在front-matter添加highlight_shrink: true
来单独配置文章收缩代码框。
highlight_shrink: true
highlight_shrink: false
highlight_shrink: none
代码换行
在默认情况下,Hexo 在编译的时候不会实现代码自动换行。如果你不希望在代码块的区域里有横向滚动条的话,那麽你可以考虑开启这个功能。
修改 主题配置文件
1 | code_word_wrap: true |
如果你是使用 highlight 渲染,需要找到你站点的 Hexo 配置文件_config.yml
,将line_number
改成false
:
1 | highlight: |
如果你是使用 prismjs 渲染,需要找到你站点的 Hexo 配置文件_config.yml
,将line_number
改成false
:
1 | prismjs: |
设置
code_word_wrap
之前:
设置
code_word_wrap
之后:
代码高度限制
3.7.0 及以上支持
可配置代码高度限制,超出的部分会隐藏,并显示展开按钮。
1 | highlight_height_limit: false # unit: px |
注意:
单位是
px
,直接添加数字,如 200实际限制高度为
highlight_height_limit + 30 px
,多增加 30px 限制,目的是避免代码高度只超出highlight_height_limit 一点时,出现展开按钮,展开没内容。不适用于隐藏后的代码块( css 设置 display: none)
社交图标
Butterfly支持 font-awesome v6图标.
书写格式 图标名:url || 描述性文字
1 | social: |
图标名可在这寻找
PC:
Mobile:
主页文章节选(自动节选和文章页description)
因为主题UI的关係,主页文章节选
只支持自动节选
和文章页description
。
在butterfly
里,有四种可供选择
- description: 只显示description
- both: 优先选择description,如果没有配置description,则显示自动节选的内容
- auto_excerpt:只显示自动节选
- false: 不显示文章内容
修改 主题配置文件
1 | index_post_content: |
description
在front-matter里添加
顶部图
如果不要显示顶部图,可直接配置 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 |
其它页面 (tags/categories/自建页面)和 文章页 的 top_img
,请到对应的 md 页面设置front-matter
中的top_img
以上所有的 top_img 可配置以下值
3.2.0 以下版本的配置只支持
- 留空,true 和 false - 显示默认的顔色
- img链接 - 显示所配置的图片
配置的值 | 效果 |
---|---|
留空 | 显示默认的top_img(如有),否则显示默认的顔色 (文章页top_img留空的话,会显示 cover 的值) |
img链接 | 图片的链接,显示所配置的图片 |
顔色( HEX值 - #0000FF RGB值 - rgb(0,0,255) 顔色单词 - orange 渐变色 - linear-gradient( 135deg, #E2B0FF 10%, #9F44D3 100%) ) |
对应的顔色 |
transparent | 透明 |
false | 不显示 top_img |
tag_per_img
和 category_per_img
是 3.2.0 新增的内容,可对 tag 和 category 进行单独的配置
并不推荐为每个 tag 和每个 category 都配置不同的顶部图,因为配置太多会拖慢生成速度
1 | tag_per_img: |
top_img: false
top_img: orange
top_img: ‘linear-gradient(20deg, #0062be, #925696, #cc426e, #fb0347)’
文章置顶
【推荐】hexo-generator-index
从 2.0.0 开始,已经支持文章置顶功能。你可以直接在文章的front-matter
区域里添加sticky: 1
属性来把这篇文章置顶。数值越大,置顶的优先级越大。
文章封面
文章的markdown文档上,在Front-matter
添加cover
,并填上要显示的图片地址。
如果不配置cover
,可以设置显示默认的cover.
如果不想在首页显示cover,可以设置为false
修改 主题配置文件
1 | cover: |
当配置多张图片时,会随机选择一张作为cover.此时写法应为
1 | default_cover: |
left
right
both
文章页相关配置
文章meta显示
这个选项是用来显示文章的相关信息的。
修改 主题配置文件
1 | post_meta: |
主页
文章页
date_format
是 3.2.0 新增的内容,配置时间显示明确时间还是相对时间
相对时间
明确时间
文章版权
为你的博客文章展示文章版权和许可协议。
修改 主题配置文件
1 | post_copyright: |
由于Hexo 4.1
开始,默认对网址进行解码,以至于如果是中文网址,会被解码,可设置decode: true
来显示中文网址。
如果有文章(例如:转载文章)不需要显示版权,可以在文章Front-matter单独设置
1 | copyright: false |
从3.0.0
开始,支持对单独文章设置版权信息,可以在文章Front-matter单独设置
1 | copyright_author: xxxx |
版权显示截图
文章打赏
在你每篇文章的结尾,可以添加打赏按钮。相关二维码可以自行配置。
对于没有提供二维码的,可配置一张软件的icon图片,然后在link上添加相应的打赏链接。用户点击图片就会跳转到链接去。
link可以不写,会默认为图片的链接。
修改 主题配置文件
1 | reward: |
TOC
在文章页,会有一个目录,用于显示TOC。
修改 主题配置文件
1 | toc: |
属性 | 解释 |
---|---|
post | 文章页是否显示 TOC |
page | 普通页面是否显示 TOC |
number | 是否显示章节数 |
expand | 是否展开 TOC |
style_simple | 简洁模式(侧边栏只显示 TOC, 只对文章页有效 ) |
Toc PC
Toc Mobile
style_simple: true
为特定的文章配置
在你的文章md
文件的头部,加入toc_number
和toc
,并配置true
或者false
即可。
主题会优先判断文章Markdown的Front-matter是否有配置,如有,则以Front-matter的配置为准。否则,以主题配置文件中的配置为准
相关文章
相关文章推荐的原理是根据文章tags的比重来推荐
修改 主题配置文件
1 | related_post: |
文章锚点
开启文章锚点后,当你在文章页进行滚动时,文章链接会根据标题ID进行替换
(注意: 每替换一次,会留下一个历史记录。所以如果一篇文章有很多锚点的话,网页的历史记录会很多。)
修改 主题配置文件
1 | # anchor |
文章过期提醒
可设置是否显示文章过期提醒,以更新时间为基准。
1 | # Displays outdated notice for a post (文章过期提醒) |
limit_day
: 距离更新时间多少天才显示文章过期提醒
message_prev
: 天数之前的文字
message_next
:天数之后的文字
style: flat
style: simple
文章编辑按钮
在文章标题旁边显示一个编辑按钮,点击会跳转到对应的链接去。
1 | # Post edit |
文章分页按钮
可设置分页的逻辑,也可以关闭分页显示
1 | # post_pagination (分页) |
参数 | 解释 |
---|---|
post_pagination: false | 关闭分页按钮 |
post_pagination: 1 | 下一篇显示的是旧文章 |
post_pagination: 2 | 下一篇显示的是新文章 |
头像
修改 主题配置文件
1 | avatar: |
图片描述
可开启图片Figcaption描述文字显示
优先显示图片的 title 属性,然后是 alt 属性
修改 主题配置文件
1 | photofigcaption: true |
複制相关配置
可配置网站是否可以複制、複制的内容是否添加版权信息
1 | # copy settings |
配置 | 解释 |
---|---|
enable | 是否开启网站複制权限 |
copyright | 複制的内容后面加上版权信息 |
enable | 是否开启複制版权信息添加 |
limit_count | 字数限制,当複制文字大于这个字数限制时,将在複制的内容后面加上版权信息 |
添加版权信息后
1 | Lorem ipsum dolor sit amet, test link consectetur adipiscing elit. Strong text pellentesque ligula commodo viverra vehicula. Italic text at ullamcorper enim. Morbi a euismod nibh. Underline text non elit nisl. Deleted text tristique, sem id condimentum tempus, metus lectus venenatis mauris, sit amet semper lorem felis a eros. Fusce egestas nibh at sagittis auctor. Sed ultricies ac arcu quis molestie. Donec dapibus nunc in nibh egestas, vitae volutpat sem iaculis. Curabitur sem tellus, elementum nec quam id, fermentum laoreet mi. Ut mollis ullamcorper turpis, vitae facilisis velit ultricies sit amet. Etiam laoreet dui odio, id tempus justo tincidunt id. Phasellus scelerisque nunc sed nunc ultricies accumsan. |
Footer 设置
博客年份
since
是一个来展示你站点起始时间的选项。它位于页面的最底部。
修改 主题配置文件
1 | footer: |
页脚自定义文本
custom_text
是一个给你用来在页脚自定义文本的选项。通常你可以在这里写声明文本等。支持 HTML。
修改 主题配置文件
1 | custom_text: Hi, welcome to my <a href="https://butterfly.js.org/">blog</a>! |
对于部分人需要写 ICP 的,也可以写在 custom_text
里
1 | custom_text: <a href="icp链接"><img class="icp-icon" src="icp图片"><span>备案号:xxxxxx</span></a> |
右下角按钮
简繁转换
简体繁体互换
右下角会有简繁转换按钮。
修改 主题配置文件
1 | translate: |
简体
繁体
夜间模式
右下角会有夜间模式按钮
修改 主题配置文件
1 | # dark mode |
V2.0.0 开始增加一个选项,可开启自动切换light mode 和 dark mode
autoChangeMode: 1 跟随系统而变化,不支持的浏览器/系统将按照时间晚上6点到早上6点之间切换为 dark mode
autoChangeMode: 2 只按照时间 晚上6点到早上6点之间切换为 dark mode,其馀时间为light mode
autoChangeMode: false 取消自动切换
閲读模式
閲读模式下会去掉除文章外的内容,避免干扰閲读。
只会出现在文章页面,右下角会有閲读模式按钮。
修改 主题配置文件
1 | readmode: true |
按钮排序
1 | # Don't modify the following settings unless you know how they work (非必要请不要修改 ) |
注意: 不要重複
侧边栏设置
侧边排版
可自行决定哪个项目需要显示,可决定位置,也可以设置不显示侧边栏。
修改 主题配置文件
1 | aside: |
position: left
position: right
card_tags color: false
card_tags color: true
aside button
访问人数 busuanzi (UV 和 PV)
访问 busuanzi 的官方网站查看更多的介绍。
修改 主题配置文件
1 | busuanzi: |
运行时间
网页已运行时间
修改 主题配置文件
1 | runtimeshow: |
最新评论
3.1.0 起支持
最新评论只会在刷新时才会去读取,并不会实时变化
由于 API 有 访问次数限制,为了避免调用太多,主题默认存取期限为 10 分钟。也就是説,调用后资料会存在 localStorage 里,10分钟内刷新网站只会去 localStorage 读取资料。 10 分钟期限一过,刷新页面时才会去调取 API 读取新的数据。( 3.6.0 新增了 storage
配置,可自行配置缓存时间)
在侧边栏显示最新评论板块
修改 主题配置文件
1 | # Aside widget - Newest Comments |
部分配置解释:
配置 | 解释 |
---|---|
limit | 显示的数量 |
storage | 设置缓存时间,单位 分钟 |
avatar | 是否显示头像 |
Demo
自定义添加栏目
点击前往标籤外挂(Tag Plugins)
标籤外挂是Hexo独有的功能,并不是标准的Markdown格式。
以下的写法,只适用于Butterfly主题,用在其它主题上不会有效果,甚至可能会报错。使用前请留意
标籤外挂虽然能为主题带来一些额外的功能和UI方面的强化,但是,标籤外挂也有明显的限制,使用时请留意。
Note (Bootstrap Callout)
移植于next主题,并进行修改。
修改 主题配置文件
1 | note: |
icons
和light_bg_offset
只对方法一生效
Note 标籤外挂有两种用法
1 | {% note [class] [no-icon] [style] %} |
名称 | 用法 |
---|---|
class | 【可选】标识,不同的标识有不同的配色 ( default / primary / success / info / warning / danger ) |
no-icon | 【可选】不显示 icon |
style | 【可选】可以覆盖配置中的 style (simple/modern/flat/disabled) |
simple
1 | {% note simple %} |
默认 提示块标籤
default 提示块标籤
primary 提示块标籤
success 提示块标籤
info 提示块标籤
warning 提示块标籤
danger 提示块标籤
modern
1 | {% note modern %} |
默认 提示块标籤
default 提示块标籤
primary 提示块标籤
success 提示块标籤
info 提示块标籤
warning 提示块标籤
danger 提示块标籤
flat
1 | {% note flat %} |
默认 提示块标籤
default 提示块标籤
primary 提示块标籤
success 提示块标籤
info 提示块标籤
warning 提示块标籤
danger 提示块标籤
disabled
1 | {% note disabled %} |
默认 提示块标籤
default 提示块标籤
primary 提示块标籤
success 提示块标籤
info 提示块标籤
warning 提示块标籤
danger 提示块标籤
no-icon
1 | {% note no-icon %} |
3.2.0 以上版本支
1 | {% note [color] [icon] [style] %} |
名称 | 用法 |
---|---|
color | 【可选】顔色 (default / blue / pink / red / purple / orange / green) |
icon | 【可选】可配置自定义 icon (只支持 fontawesome 图标, 也可以配置 no-icon ) |
style | 【可选】可以覆盖配置中的 style (simple/modern/flat/disabled) |
simple
1 | {% note 'fab fa-cc-visa' simple %} |
你是刷 Visa 还是 UnionPay
2021年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
modern
1 | {% note 'fab fa-cc-visa' modern %} |
你是刷 Visa 还是 UnionPay
2021年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
flat
1 | {% note 'fab fa-cc-visa' flat %} |
你是刷 Visa 还是 UnionPay
2021年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
disabled
1 | {% note 'fab fa-cc-visa' disabled %} |
你是刷 Visa 还是 UnionPay
2021年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
no-icon
1 | {% note no-icon %} |
Gallery相册图库
2.2.0以上提供
一个图库集合。
写法
1 | <div class="gallery-group-main"> |
- name:图库名字
- description:图库描述
- link:连接到对应相册的地址
- img-url:图库封面的地址
例如:
1 | <div class="gallery-group-main"> |
Gallery相册
2.0.0以上提供
区别于旧版的Gallery相册,新的Gallery相册会自动根据图片长度进行排版,书写也更加方便,与markdown格式一样。可根据需要插入到相应的md。
写法:
1 | {% gallery %} |
例如
1 | {% gallery %} |
tag-hide
2.2.0以上提供
请注意,tag-hide内的标签外挂content内都不建议有h1 - h6 等标题。因为Toc会把隐藏内容标题也显示出来,而且当滚动屏幕时,如果隐藏内容没有显示出来,会导致Toc的滚动出现异常。
如果你想把一些文字、内容隐藏起来,并提供按钮让用户点击显示。可以使用这个标籤外挂。
inline
在文本里面添加按钮隐藏内容,只限文字
( content不能包含英文逗号,可用‚
)
1 | {% hideInline content,display,bg,color %} |
content: 文本内容
display: 按钮显示的文字(可选)
bg: 按钮的背景颜色(可选)
color: 按钮文字的颜色(可选)
Demo
1 | 哪个英文字母最酷? {% hideInline 因为西装裤(C装酷),查看答案,#FF7242,#fff %} |
哪个英文字母最酷?
门里站着一个人?
block
独立的block隐藏内容,可以隐藏很多内容,包括图片,代码块等等
( display 不能包含英文逗号,可用‚
)
1 | {% hideBlock display,bg,color %} |
- content: 文本内容
- display: 按钮显示的文字(可选)
- bg: 按钮的背景颜色(可选)
- color: 按钮文字的颜色(可选)
Demo
1 | 查看答案 |
查看答案
2.3.0以上支持
如果你需要展示的内容太多,可以把它隐藏在收缩框里,需要时再把它展开。
( display 不能包含英文逗号,可用‚
)
1 | {% hideToggle display,bg,color %} |
Demo
1 | {% hideToggle Butterfly安装方法 %} |
Butterfly安装方法
在你的博客根目录里
git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly
如果想要安装比较新的dev分支,可以
git clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/Butterfly
mermaid
使用mermaid标籤可以绘制Flowchart(流程图)、Sequence diagram(时序图 )、Class Diagram(类别图)、State Diagram(状态图)、Gantt(甘特图)和Pie Chart(圆形图),具体可以查看mermaid文档
修改 主题配置文件
1 | # mermaid |
写法:
1 | {% mermaid %} |
例如:
1 | {% mermaid %} |
Tabs
移植于next主题
使用方法
1 | {% tabs Unique name, [index] %} |
Demo 1 - 预设选择第一个【默认】
1 | {% tabs test1 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
Demo 2 - 预设选择tabs
1 | {% tabs test2, 3 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
Demo 3 - 没有预设值
1 | {% tabs test3, -1 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
Demo 4 - 自定义Tab名 + 只有icon + icon和Tab名
1 | {% tabs test4 %} |
tab名字为第一个Tab
只有图标 没有Tab名字
名字+icon
Button
3.0以上适用
使用方法:
1 | {% btn [url],[text],[icon],[color] [style] [layout] [position] [size] %} |
Demo
1 | This is my website, click the button {% btn 'https://butterfly.js.org/',Butterfly %} |
This is my website, click the button Butterfly
This is my website, click the button Butterfly
This is my website, click the button Butterfly
This is my website, click the button Butterfly
This is my website, click the button Butterfly
1 | {% btn 'https://butterfly.js.org/',Butterfly,far fa-hand-point-right,block %} |
more than one button in center
1 | {% btn 'https://butterfly.js.org/',Butterfly,far fa-hand-point-right,larger %} |
1 | <div class="btn-center"> |
inlineImg
主题中的图片都是默认以块级元素
显示,如果你想以内联元素
显示,可以使用这个标签外挂。
1 | {% inlineImg [src] [height] %} |
Demo
1 | 你看我长得漂亮不 |
label
3.7.5 及以上版本适用
高亮所需的文字
1 | {% label text color %} |
参数 | 解释 |
---|---|
text | 文字 |
color | 【可选】背景颜色,默认为 default default/blue/pink/red/purple/orange/green |
Demo
1 | 臣亮言:{% label 先帝 %}创业未半,而{% label 中道崩殂 blue %}。今天下三分,{% label 益州疲敝 pink %},此诚{% label 危急存亡之秋 red %}也!然侍衞之臣,不懈于内;{% label 忠志之士 purple %},忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。 |
臣亮言:先帝 创业未半,而中道崩殂 。今天下三分,益州疲敝 ,此诚危急存亡之秋 也!然侍衞之臣,不懈于内;忠志之士 ,忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。
宫中、府中,俱为一体;陟罚臧否,不宜异同。若有作奸 、犯科 ,及为忠善者,宜付有司,论其刑赏,以昭陛下平明之治;不宜偏私,使内外异法也。
timeline
4.0.0 以上支持
1 | {% timeline title,color %} |
参数 | 解释 |
---|---|
title | 标题/时间线 |
color | timeline 颜色 default(留空) / blue / pink / red / purple / orange / green |
Demo
1 | {% timeline 2022 %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,blue %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,pink %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,red %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,purple %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,orange %} |
2022
01-02
这是测试页面
1 | {% timeline 2022,green %} |
2022
01-02
这是测试页面
flink
4.1.0 支持
可在任何界面插入类似友情链接列表效果
内容格式与友情链接界面一样,支持 yml 格式
1 | {% flink %} |
Demo
1 | {% flink %} |