Hexo Butterfly 使用手册
标签外挂
标签外挂是 Hexo 独有的功能,并不是标准的 Markdown 格式。
Note
1 | {% note 'fab fa-cc-visa' simple %} |
你是刷 Visa 还是是 UnionPay
2021年快到了....
小心开车 安全至上
这是三片呢?还是四片?
该充电了哦!
剪刀石頭布
前端最討厭的瀏覽器
1 | {% note 'fab fa-cc-visa' modern %} |
你是刷 Visa 还是是 UnionPay
2021年快到了....
小心开车 安全至上
这是三片呢?还是四片?
该充电了哦!
剪刀石頭布
前端最討厭的瀏覽器
1 | {% note 'fab fa-cc-visa' flat %} |
你是刷 Visa 还是是 UnionPay
2021年快到了....
小心开车 安全至上
这是三片呢?还是四片?
该充电了哦!
剪刀石頭布
前端最討厭的瀏覽器
1 | {% note 'fab fa-cc-visa' disabled %} |
你是刷 Visa 还是是 UnionPay
2021年快到了....
小心开车 安全至上
这是三片呢?还是四片?
该充电了哦!
剪刀石頭布
前端最討厭的瀏覽器
1 | {% note no-icon %} |
复选列表 checkbox
1 | {% checkbox 样式参数(可选), 文本(支持简单md) %} |
- 样式: plus, minus, times
- 颜色: red ,yellow ,green ,cyan ,blue ,gray
- 选中状态: checked
1 | {% checkbox 纯文本测试 %} |
样式示例
纯文本测试
支持简单的 [markdown] 语法
支持自定义颜色
绿色 + 默认选中
黄色 + 默认选中
青色 + 默认选中
蓝色 + 默认选中
增加
减少
叉
单选列表 radio
1 | {% radio 样式参数(可选), 文本(支持简单md) %} |
- 颜色: red ,yellow ,green ,cyan ,blue ,gray
- 选中状态: checked
1 | {% radio 纯文本测试 %} |
样式示例
纯文本测试
支持简单的 markdown 语法
支持自定义颜色
绿色
黄色
青色
蓝色
时间轴 timeline
1 | {% timeline 时间线标题(可选)[,color] %} |
2020-07
2020-07-24
天气不错,适合出去约妹
2020-05-15
学习 SpringCloud Alibaba
1 | {% timeline 2020-07,blue %} |
文本相关
行内文本样式 text
1 | {% u 文本内容 %} |
- 带 下划线 的文本
- 带
着重号 的文本 - 带
波浪线 的文本 - 带
删除线的文本 - 键盘样式的文本 command + D
- 密码样式的文本:
这里没有验证码
1 | 1. 带 {% u 下划线 %} 的文本 |
行内文本 span
1 | {% span 样式参数(参数以空格划分), 文本内容 %} |
- 字体: logo, code
- 颜色: red,yellow,green,cyan,blue,gray
- 大小: small, h4, h3, h2, h1, large, huge, ultra
- 对齐方向: left, center, right
- 彩色文字 在一段话中方便插入各种颜色的标签,包括:红色、黄色、绿色、青色、蓝色、灰色。
- 超大号文字 文档「开始」页面中的标题部分就是超大号文字。 Volantis A Wonderful Theme for Hexo
1 | - 彩色文字 |
链接卡片 link
1 | {% link 标题, 链接, 图片链接(可选) %} |
1 | {% link GitHub, https://github.com, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@450ea647ca67bd386416a689f3eb1bc6a508b3b9/2021/01/23/f7ac7b26db76ada1704f6af09bedacbe.webp %} |
按钮 btns
1 | {% btns 样式参数 %} |
- 圆角样式:rounded, circle
- 增加文字样式:可以在容器内增加 标题 和
描述文字
- 布局方式: 默认为自动宽度,适合视野内只有一两个的情况。
参数 | 含义 |
---|---|
wide | 宽一点的按钮 |
fill | 填充布局,自动铺满至少一行,多了会换行 |
center | 居中,按钮之间是固定间距 |
around | 居中分散 |
grid2 | 等宽最多2列,屏幕变窄会适当减少列数 |
grid3 | 等宽最多3列,屏幕变窄会适当减少列数 |
grid4 | 等宽最多4列,屏幕变窄会适当减少列数 |
grid5 | 等宽最多5列,屏幕变窄会适当减少列数 |
- 一组含有头像的链接:
1
2
3
4
5
6
7{% btns circle grid5 %}
{% cell GitHub, https://github.com/, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@450ea647ca67bd386416a689f3eb1bc6a508b3b9/2021/01/23/f7ac7b26db76ada1704f6af09bedacbe.webp %}
{% cell 哔哩哔哩, https://www.bilibili.com/, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@e642ee265c8ae2bbd0994716aa12b3adbe07f2c4/2021/01/23/2ceca69a212d3b9988bbd2c41edc636c.webp %}
{% cell Pixiv, https://www.pixiv.net/, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@5c4fc20944c706aa452c31d1bddbdcc672e8c6ab/2021/01/23/7658d06315d32bcf0c954b3d8e8879e0.webp %}
{% cell YouTube, https://www.youtube.com/, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@ff4781678ea6227f5824e3c8bfd5cc27441db4da/2021/01/23/f4e292c780275465c9150eb3cb0785a4.webp %}
{% cell 今日热榜, https://tophub.today/, https://jsd.onmicrosoft.cn/gh/cpddo/p_img@11fff6ed270722d709eb0ac88ce47f468c21d2ba/2021/01/23/cd22cd9d34d7d7bd58114d7d7a195822.webp %}
{% endbtns %} - 或者含有图标的按钮:
1
2
3
4{% btns rounded grid5 %}
{% cell 下载源码, /, fas fa-download %}
{% cell 查看文档, /, fas fa-book-open %}
{% endbtns %} - 圆形图标 + 标题 + 描述 + 图片 + 网格5列 + 居中
1
2
3
4
5
6
7
8
9
10
11
12
13
14{% btns circle center grid5 %}
<a href='https://apps.apple.com/cn/app/heart-mate-pro-hrm-utility/id1463348922?ls=1'>
<i class='fab fa-apple'></i>
<b>心率管家</b>
{% p red, 专业版 %}
<img src='https://jsd.onmicrosoft.cn/gh/xaoxuu/cdn-assets/qrcode/heartmate_pro.png'>
</a>
<a href='https://apps.apple.com/cn/app/heart-mate-lite-hrm-utility/id1475747930?ls=1'>
<i class='fab fa-apple'></i>
<b>心率管家</b>
{% p green, 免费版 %}
<img src='https://jsd.onmicrosoft.cn/gh/xaoxuu/cdn-assets/qrcode/heartmate_lite.png'>
</a>
{% endbtns %}
样式预览 1. 一组含有头像的链接:
- 或者含有图标的按钮:
- 圆形图标 + 标题 + 描述 + 图片 + 网格5列 + 居中
github 卡片 ghcard
ghcard 使用了 github-readme-stats 的 API,支持直接使用 markdown 语法来写。
1 | {% ghcard 用户名, 其它参数(可选) %} |
使用,分割各个参数。写法为:参数名=参数值 以下只写几个常用参数值。
参数名 | 取值 | 释义 |
---|---|---|
hide | stars,commits,prs,issues,contribs | 隐藏指定统计 |
count_private | true | 将私人项目贡献添加到总提交计数中 |
show_icons | true | 显示图标 |
theme | 请查阅Available Themes | 主题 |
- 用户信息卡片
1
2
3
4
5| {% ghcard jerryc127 %} | {% ghcard Zfour, theme=vue %} |
| ------------------------------------ | ------------------------------------------ |
| {% ghcard Akilarlxh, theme=buefy %} | {% ghcard ruanyf, theme=solarized-light %} |
| {% ghcard philwebb, theme=onedark %} | {% ghcard zjwo, theme=solarized-dark %} |
| {% ghcard vpavic, theme=algolia %} | {% ghcard bclozel, theme=calm %} | - 仓库信息卡片
1
2
3
4
5| {% ghcard spring-projects/spring-boot %} | {% ghcard mybatis/mybatis-3, theme=vue %} |
| -------------------------------------------------------- | ------------------------------------------------------- |
| {% ghcard jerryc127/hexo-theme-butterfly, theme=buefy %} | {% ghcard alibaba/fastjson, theme=solarized-light %} |
| {% ghcard alibaba/druid, theme=onedark %} | {% ghcard alibaba/arthas, theme=solarized-dark %} |
| {% ghcard Tencent/weui, theme=algolia %} | {% ghcard volantis-x/hexo-theme-volantis, theme=calm %} |
- 用户信息卡片
- 仓库信息卡片
github 卡片 ghbdage
1 | {% bdage [right],[left],[logo]||[color],[link],[title]||[option] %} |
left
:徽标左边的信息,必选参数。right
: 徽标右边的信息,必选参数,logo
:徽标图标,图标名称详见simpleicons
,可选参数。color
:徽标右边的颜色,可选参数。link
:指向的链接,可选参数。title
:徽标的额外信息,可选参数。主要用于优化SEO
,但object
标签不会像a标签一样在鼠标悬停显示title信息。option
:自定义参数,支持shields.io
的全部API参数支持,具体参数可以参看上文中的拓展写法示例。形式为name1=value2&name2=value2
。
本外挂标签的参数分为三组,用||分割。
基本参数,定义徽标左右文字和图标
信息参数,定义徽标右侧内容背景色,指向链接
// 如果是跨顺序省略可选参数,仍然需要写个逗号,用作分割
拓展参数,支持shields的API的全部参数内容
// 如果是跨顺序省略可选参数组,仍然需要写双竖线||用作分割
本外挂标签的参数分为三组,用||分割。 基本参数,定义徽标左右文字和图标
信息参数,定义徽标右侧内容背景色,指向链接
1
2 {% bdage Theme,Butterfly %}
{% bdage Frame,Hexo,hexo %}拓展参数,支持shields的API的全部参数内容
1
2
3 {% bdage CDN,JsDelivr,jsDelivr||abcdef,https://metroui.org.ua/index.html,本站使用JsDelivr为静态资源提供CDN加速 %}
// 如果是跨顺序省略可选参数,仍然需要写个逗号,用作分割
{% bdage Source,GitHub,GitHub||,https://github.com/ %}
1
2
3 {% bdage Hosted,Vercel,Vercel||brightgreen,https://vercel.com/,本站采用双线部署,默认线路托管于Vercel||style=social&logoWidth=20 %}
// 如果是跨顺序省略可选参数组,仍然需要写双竖线||用作分割
{% bdage Hosted,Vercel,Vercel||||style=social&logoWidth=20&logoColor=violet %}
行内图片 inlineimage
1 | {% inlineimage 图片链接, height=高度(可选) %} |
- 高度:height=20px
这是 一段话。
这又是 一段话。
1 | 这是 {% inlineimage https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-emoji/aru-l/0000.gif %} 一段话。 |
单张图片 image
1 | {% image 链接, width=宽度(可选), height=高度(可选), alt=描述(可选), bg=占位颜色(可选) %} |
图片宽度高度:width=300px, height=32px
图片描述:alt=图片描述(butterfly需要在主题配置文件中开启图片描述)
占位背景色:bg=#f2f2f2
- 添加描述:
- 指定宽度:
- 指定宽度并添加描述:
- 设置占位背景色:
- 添加描述:
1
{% image https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-wallpaper-minimalist/2020/025.jpg, alt=每天下课回宿舍的路,没有什么故事。 %}
- 指定宽度:
1
{% image https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-wallpaper-minimalist/2020/025.jpg, width=400px %}
- 指定宽度并添加描述:
1
{% image https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-wallpaper-minimalist/2020/025.jpg, width=400px, alt=每天下课回宿舍的路,没有什么故事。 %}
- 设置占位背景色:
1
{% image https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-wallpaper-minimalist/2020/025.jpg, width=400px, bg=#1D0C04, alt=优化不同宽度浏览的观感 %}
音频 audio
1 | {% audio 音频链接 %} |
1 | {% audio https://音乐链接.mp3 %} |
视频 video
1 | {% video 视频链接 %} |
- 对其方向:left, center, right
- 列数:逗号后面直接写列数,支持 1 ~ 4 列。
- 100% 宽度
- 50% 宽度
- 25% 宽度
- 100% 宽度
1
{% video 视频链接 %}
- 50% 宽度
1
2
3
4
5
6{% videos, 2 %}
{% video 视频链接 %}
{% video 视频链接 %}
{% video 视频链接 %}
{% video 视频链接 %}
{% endvideos %} - 25% 宽度
1
2
3
4
5
6
7
8
9
10{% videos, 4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% video https://www.w3school.com.cn/example/html5/mov_bbb.mp4 %}
{% endvideos %}
相册 gallery
以下为 Butterfly 自带的 gallery 标签写法。相册图库和相册配合使用。
- gallerygroup 相册图库
1
2
3
4
5<div class="gallery-group-main">
{% galleryGroup name description link img-url %}
{% galleryGroup name description link img-url %}
{% galleryGroup name description link img-url %}
</div> - gallery 相册
1
2
3{% gallery %}
markdown 图片格式
{% endgallery %}
- gallerygroup 相册图库
参数名 | 释义 |
---|---|
name | 图库名字 |
description | 图库描述 |
link | 链接到对应相册的地址 |
img-url | 图库封面 |
- gallery 相册 区别于旧版的 Gallery 相册,新的 Gallery 相册会自动根据图片长度进行排版,书写也更加方便,与 markdown 格式一样。可根据需要插入到相应的 md。无需再自己配置长宽。建议在粘贴时故意使用长短、大小、横竖不一的图片,会有更好的效果。(尺寸完全相同的图片只会平铺输出,效果很糟糕)
gallerygroup 相册图库
1
2
3<div class="gallery-group-main">
{% galleryGroup '壁纸' '源于网络,侵删!' '/photos/wallpaper/' https://jsd.onmicrosoft.cn/gh/volantis-x/cdn-wallpaper/abstract/41F215B9-261F-48B4-80B5-4E86E165259E.jpeg %}
</div>gallery 相册
1
2
3
4
5
6
7{% gallery %}
![images](https://npm.elemecdn.com/cover_img/wallpaper/work/10.jpg)
![images](https://npm.elemecdn.com/cover_img/wallpaper/work/9.jpg)
![images](https://npm.elemecdn.com/cover_img/wallpaper/work/8.jpg)
![images](https://npm.elemecdn.com/cover_img/wallpaper/work/7.jpg)
![images](https://npm.elemecdn.com/cover_img/wallpaper/work/6.jpg)
{% endgallery %}
gallerygroup 相册图库
gallery 相册
折叠框 folding
1 | {% folding 参数(可选), 标题 %} |
- 颜色:blue, cyan, green, yellow, red
- 状态:状态填写 open 代表默认打开。
1 | {% folding 查看图片测试 %} |
...
查看图片测试
查看默认打开的折叠框
这是一个默认打开的折叠框。
分栏 tab
1 | {% tabs Unique name, [index] %} |
- Unique name :
- 选项卡块标签的唯一名称,不带逗号。
- 将在#id中用作每个标签及其索引号的前缀。
- 如果名称中包含空格,则对于生成#id,所有空格将由破折号代替。
- 仅当前帖子/页面的URL必须是唯一的!
- 如果未指定,将选择第一个标签(1)。
- 如果index为-1,则不会选择任何选项卡。
- 可选参数。
- 如果未指定标题,则带有制表符索引后缀的唯一名称将用作制表符的标题。
- 如果未指定标题,但指定了图标,则标题将为空。
- 可选参数。
- [@icon]:
- FontAwesome图标名称(全名,看起来像“ fas fa-font”)
- 可以指定带空格或不带空格;
- 例如’Tab caption @icon’ 和 ‘Tab caption@icon’.
- 可选参数。
自定义 Tab 名 + 只有 icon + icon 和 Tab 名
1
2
3
4
5
6
7
8
9
10
11
12
13 {% tabs test4 %}
<!-- tab 第一个Tab -->
**tab名字为第一个Tab**
<!-- endtab -->
<!-- tab @fab fa-apple-pay -->
**只有图标 没有Tab名字**
<!-- endtab -->
<!-- tab 炸弹@fas fa-bomb -->
**名字+icon**
<!-- endtab -->
{% endtabs %}
自定义 Tab 名 + 只有 icon + icon 和 Tab 名
tab名字为第一个Tab
只有图标 没有Tab名字
名字+icon
诗词标签 poem
1 | {% poem [title],[author] %} |
- title:诗词标题
- author:作者,可以不写
1 | {% poem 水调歌头,苏轼 %} |
丙辰中秋,欢饮达旦,大醉,作此篇,兼怀子由。 明月几时有?把酒问青天。 不知天上宫阙,今夕是何年? 我欲乘风归去,又恐琼楼玉宇,高处不胜寒。 起舞弄清影,何似在人间?
转朱阁,低绮户,照无眠。 不应有恨,何事长向别时圆? 人有悲欢离合,月有阴晴圆缺,此事古难全。 但愿人长久,千里共婵娟。
label
适用于 Butterfly 3.7.5 及以上版本
1 | {% label text color %} |
参数 | 解释 |
---|---|
text | 文字 |
color | 【可选】背景颜色,默认为 default |
default | / blue / pink / red / purple / orange / green |
臣亮言:先帝 创业未半,而中道崩殂 。今天下三分,益州疲敝 ,此诚危急存亡之秋 也!然侍衞之臣,不懈于内;忠志之士 ,忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。 宫中、府中,俱为一体;陟罚臧否,不宜异同。若有作奸 、犯科 ,及为忠善者,宜付有司,论其刑赏,以昭陛下平明之治;不宜偏私,使内外异法也。
1 | 臣亮言:{% label 先帝 %}创业未半,而{% label 中道崩殂 blue %}。今天下三分,{% label 益州疲敝 pink %},此诚{% label 危急存亡之秋 red %}也!然侍衞之臣,不懈于内;{% label 忠志之士 purple %},忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。 |
进度条 progress
1 | {% progress [width] [color] [text] %} |
- width:0 到 100 的阿拉伯数字
- color:颜色,取值有 red、yellow、green、cyan、blue、gray
- text:进度条上的文字内容
1 | {% progress 10 red 进度条样式预览 %} |
参考文献
https://akilar.top/posts/615e2dec/
https://blog.imzjw.cn/posts/bfdocs/index.html