梦开始的地方
Markdown
Butterfly主题支持Markdown语法，除此之外还可以添加MarkdownIt 插件上的语法，只需要在_config.yml文件中配置markdown->plugins即可。
Front-matter
- Page Front-matter
---
title:
date:
updated:
type:
comments:
description:
keywords:
top_img:
mathjax:
katex:
aside:
aplayer:
highlight_shrink:
random:
limit:
type:
value:
---
|
| 参数 |
解释 |
| title |
【必需】页面标题 |
| date |
【必需】页面创建日期 |
| type |
【必需】标签、分类和友情链接三个页面需要配置 |
| updated |
【可选】页面更新日期 |
| description |
【可选】页面描述 |
| keywords |
【可选】页面关键字 |
| comments |
【可选】显示页面评论模块（默认 true） |
| top_img |
【可选】页面顶部图片 |
| mathjax |
【可选】显示 mathjax（当设置 mathjax 的 per_page: false 时，才需要配置，默认 false） |
| katex |
【可选】显示 katex（当设置 katex 的 per_page: false 时，才需要配置，默认 false） |
| aside |
【可选】显示侧边栏（默认 true） |
| aplayer |
【可选】在需要的页面加载 aplayer 的 js 和 css，请参考文章下面的音乐配置 |
| highlight_shrink |
【可选】配置代码框是否展开（true/false）（默认为设置中 highlight_shrink 的配置） |
| random |
【可选】配置友情链接是否随机排序（默认为 false） |
| limit |
【可选】配置説説显示数量 |
| limit.type |
【可选】配置説説显示数量的类型（date 或者 num） |
| limit.value |
【可选】配置説説显示数量的值 |
- Post Front-matter
---
title:
date:
updated:
tags:
categories:
keywords:
description:
top_img:
comments:
cover:
series:
toc:
toc_number:
toc_style_simple:
copyright:
copyright_author:
copyright_author_href:
copyright_url:
copyright_info:
mathjax:
katex:
aplayer:
highlight_shrink:
aside:
abcjs:
noticeOutdate:
password:
abstract:
message:
wrong_pass_message:
wrong_hash_message:
---
|
| 参数 |
解释 |
| title |
【必需】文章标题 |
| date |
【必需】文章创建日期 |
| updated |
【可选】文章更新日期 |
| tags |
【可选】文章标签 |
| categories |
【可选】文章分类 |
| keywords |
【可选】文章关键字 |
| description |
【可选】文章描述 |
| top_img |
【可选】文章顶部图片 |
| cover |
【可选】文章缩略图（如果没有设置 top_img，文章页顶部将显示缩略图，可设为 false/图片地址/留空） |
| comments |
【可选】显示文章评论模块（默认 true） |
| series |
【可选】指定系列文章 |
| toc |
【可选】显示文章 TOC（默认为设置中 toc 的 enable 配置） |
| toc_number |
【可选】显示 toc_number（默认为设置中 toc 的 number 配置） |
| toc_style_simple |
【可选】显示 toc 简洁模式 |
| copyright |
【可选】显示文章版权模块（默认为设置中 post_copyright 的 enable 配置） |
| copyright_author |
【可选】文章版权模块的文章作者 |
| copyright_author_href |
【可选】文章版权模块的文章作者链接 |
| copyright_url |
【可选】文章版权模块的文章连结链接 |
| copyright_info |
【可选】文章版权模块的版权声明文字 |
| mathjax |
【可选】显示 mathjax（当设置 mathjax 的 per_page: false 时，才需要配置，默认 false） |
| katex |
【可选】显示 katex（当设置 katex 的 per_page: false 时，才需要配置，默认 false） |
| aplayer |
【可选】在需要的页面加载 aplayer 的 js 和 css，请参考文章下面的音乐配置 |
| highlight_shrink |
【可选】配置代码框是否展开（true/false）（默认为设置中 highlight_shrink 的配置） |
| aside |
【可选】显示侧边栏（默认 true） |
| abcjs |
【可选】加载 abcjs（当设置 abcjs 的 per_page: false 时，才需要配置，默认 false） |
| noticeOutdate |
【可选】文章过期提醒（默认为设置中 noticeOutdate 的 enable 配置） |
| password |
【可选】文章加密密码 |
| abstract |
【可选】文章加密说明信息 |
| message |
【可选】文章加密输入框提示信息 |
| wrong_pass_message |
【可选】文章加密密码错误提示信息 |
| wrong_hash_message |
【可选】文章加密无法校验提示信息 |
标签外挂
标签外挂是 Hexo 独有的功能，并不是标准的 Markdown 格式。
提示块
{% note [class] [icon] [style] %}
提示文本。
{% endnote %}
|
| 选项 |
描述 |
| class |
标识（default / primary / success / info / warning / danger） |
| icon |
fontawesome 图标 |
| style |
样式风格（simple/modern/flat/disabled） |
图库
<div class="gallery-group-main">
{% galleryGroup name description link img-url %}
</div>
|
| 选项 |
描述 |
| name |
图库名字 |
| description |
图库描述 |
| link |
相册地址 |
| img-url |
图库封面 |
相册
{% gallery url,[link],[button] %}
md格式图片
{% endgallery %}
|
| 选项 |
描述 |
| url |
识别词，添加后将使用 json 链接源 |
| link |
远程的 json 链接 |
| button |
是否展示加载更多图片按钮（默认false） |
json格式如下：
[
{
"url": "图片链接",
"alt": "图片名称",
"title": "图片标题"
}
]
|
行图片
{% inlineImg [src] [height] %}
|
| 选项 |
描述 |
| src |
图片链接 |
| height |
高度限制 |
隐藏
- 行内隐藏
{% hideInline content,display,bg,color %}
|
- 块隐藏
{% hideBlock display,bg,color %}
content
{% endhideBlock %}
|
- 段隐藏
{% hideToggle display,bg,color %}
content
{% endhideToggle %}
|
| 选项 |
描述 |
| content |
文本内容 |
| display |
按钮显示的文字 |
| bg |
按钮的背景颜色 |
| color |
按钮文字的颜色 |
分栏
{% tabs name, [index] %}
<!-- tab [caption] [icon] -->
content
<!-- endtab -->
<!-- tab [caption] [icon] -->
content
<!-- endtab -->
{% endtabs %}
|
| 选项 |
描述 |
| name |
唯一名称 |
| index |
初始选项索引 |
| caption |
当前分栏的标题 |
| icon |
fontawesome 图标 |
按钮
{% btn [url],[text],[icon],[color] [style] [layout] [position] [size] %}
|
| 选项 |
描述 |
| url |
链接地址 |
| text |
按钮文字 |
| icon |
fontawesome 图标 |
| color |
背景顔色（default/blue/pink/red/purple/orange/green） |
| style |
按钮样式（outline/留空） |
| layout |
按钮布局（block/留空） |
| position |
按钮位置（center/right/留空） |
| size |
按钮大小（larger/留空） |
标记
| 选项 |
描述 |
| text |
链接地址 |
| color |
背景颜色（default/blue/pink/red/purple/orange/green） |
时间轴
{% timeline title,color %}
<!-- timeline title -->
content
<!-- endtimeline -->
<!-- timeline title -->
content
<!-- endtimeline -->
{% endtimeline %}
|
| 选项 |
描述 |
| title |
标题/时间线 |
| color |
timeline 颜色（default/blue/pink/red/purple/orange/green） |
外链
{% flink %}
- class_name: 外链分类大标题
class_desc: 外链分类描述
link_list:
- name: 外链名称
link: 外链链接
avatar: 外链头像
descr: 外链描述
{% endflink %}
|
系列块
{% series %}
{% series [series-name] %}
|
| 选项 |
描述 |
| series-name |
front-matter上添加的series参数值 |
图表
{% chartjs [width, abreast, chartId] %}
<!-- chart -->
图标
<!-- endchart -->
<!-- desc -->
描述
<!-- enddesc -->
{% endchartjs %}
|
| 选项 |
描述 |
| width |
图表宽度 |
| abreast |
是否并排显示图标和描述 |
| chartId |
图表 ID |
音乐播放器
参考hexo-tag-aplayer。
- 本地资源
{% aplayer title author url [picture_url, narrow, autoplay, width:xxx, lrc:xxx] %}
|
| 选项 |
描述 |
| title |
标题 |
| author |
作者 |
| url |
音乐文件 URL 地址 |
| picture_url |
对应的图片地址 |
| narrow |
播放器袖珍风格 |
| autoplay |
自动播放，移动端不支持 |
| width |
播放器宽度 |
| lrc |
歌词文件 URL 地址 |
- 引用资源
| 选项 |
默认值 |
描述 |
| id |
必须值 |
歌曲 id / 播放列表 id / 相册 id / 搜索关键字 |
| server |
必须值 |
音乐平台: netease, tencent, kugou, xiami, baidu |
| type |
必须值 |
song, playlist, album, search, artist |
| fixed |
false |
开启固定模式 |
| mini |
false |
开启迷你模式 |
| loop |
all |
列表循环模式：all, one,none |
| order |
list |
列表播放模式： list, random |
| volume |
0.7 |
播放器音量 |
| lrctype |
0 |
歌词格式类型 |
| listfolded |
false |
指定音乐播放列表是否折叠 |
| storagename |
metingjs |
LocalStorage 中存储播放器设定的键名 |
| autoplay |
true |
自动播放，移动端浏览器暂时不支持此功能 |
| mutex |
true |
该选项开启时，如果同页面有其他 aplayer 播放，该播放器会暂停 |
| listmaxheight |
340px |
播放列表的最大长度 |
| preload |
auto |
音乐文件预载入模式，可选项： none, metadata, auto |
| theme |
#ad7a86 |
播放器风格色彩设置 |
视频播放器
参考hexo-tag-dplayer。
{% dplayer "key=value" %}
|
| 选项 |
默认值 |
描述 |
| url |
必填 |
视频文件地址（支持 mp4 / m3u8 等） |
| pic |
空 |
视频封面图片地址 |
| thumbnails |
空 |
视频缩略图（预览图）地址 |
| autoplay |
false |
是否自动播放（部分浏览器会限制） |
| loop |
false |
是否循环播放 |
| mutex |
true |
是否互斥播放（页面多个播放器时只播放一个） |
| volume |
0.7 |
默认音量（0~1） |
| preload |
auto |
视频预加载模式，可选：none / metadata / auto |
| theme |
#b7daff |
播放器主题颜色 |
| lang |
zh-cn |
播放器语言，可选：zh-cn / en 等 |
| screenshot |
false |
是否开启截图功能 |
| hotkey |
true |
是否启用快捷键控制 |
| airplay |
true |
是否支持 AirPlay |
| chromecast |
false |
是否支持 Chromecast |
| playbackSpeed |
false |
是否开启倍速播放功能 |
| defaultQuality |
0 |
默认清晰度索引（多清晰度时使用） |
| quality |
空 |
多清晰度视频配置（JSON 数组格式） |
| danmaku |
空 |
弹幕配置（JSON 对象，需后端支持） |
| api |
空 |
弹幕 API 地址（用于加载/发送弹幕） |
| id |
空 |
弹幕 ID（用于区分不同视频） |
| addition |
空 |
额外弹幕数据（JSON 数组） |
| video |
空 |
视频扩展配置（JSON 对象） |
| subtitle |
空 |
字幕配置（JSON 对象，支持 VTT） |
思维导图
参考hexo-markmap。
{% markmap height %}
---
id:
markmap:
initialExpandLevel:
colorFreezeLevel:
pan:
zoom:
---
# 一级节点
## 二级节点
### 三级节点
#### 四级节点
##### 五级节点
###### 六级节点
- 最终节点
{% endmarkmap %}
|
| 选项 |
描述 |
| height |
导图高度 |
| id |
导图ID |
| initialExpandLevel |
初始展开节点等级 |
| colorFreezeLevel |
自由颜色节点等级 |
| pan |
是否可以拖动 |
| zoom |
是否可以缩放 |
微信
