文档
最新内容请查看 Butterfly 文档(二) 主题页面 与 Butterfly 文档(四) 标签外挂
Front-matter
Front-matter 是档案最上方以 ---
分隔的区域,用于指定个別档案的变数。
如果标注可选
的参數,可根据自己需要添加,不用全部都写在 markdown 里
Page Front-matter
1 | --- |
寫法 | 类型 | 解釋 |
---|---|---|
title | String | 【必需】页面标题 |
date | Date | 【必需】页面创建日期 |
type | String | 【必需】标签、分类和友情链接三个页面需要配置 |
updated | Date | 【可选】页面更新日期 |
description | String | 【可选】页面描述 |
keywords | String | 【可选】页面关键字 |
comments | Boolean | 【可选】显示页面评论模块(默认 true) |
top_img | Boolean | 【可选】页面顶部图片 |
mathjax | Boolean | 【可选】显示 mathjax(当设置 mathjax 的 per_page: false 时,才需要配置,默认 false) |
katex | Boolean | 【可选】显示 katex(当设置 katex 的 per_page: false 时,才需要配置,默认 false) |
aside | Boolean | 【可选】显示侧边栏 (默认 true) |
aplayer | Boolean | 【可选】在需要的页面加载 aplayer 的 js 和 css,请参考文章下面的 音樂 配置 |
highlight_shrink | Boolean | 【可选】配置代码框是否展开(true/false)(默认为设置中 highlight_shrink 的配置) |
random | Boolean | 【可选】配置友情链接是否随机排序(默认为 false) |
limit | Number | 【可选】配置説説显示数量 |
limit.type | String | 【可选】配置説説显示数量的类型 (date 或者 num) |
limit.value | Number | 【可选】配置説説显示数量的值 |
Post Front-matter
1 | --- |
寫法 | 解釋 |
---|---|
title | 【必需】文章标题 |
date | 【必需】文章创建日期 |
updated | 【可选】文章更新日期 |
tags | 【可选】文章标签 |
categories | 【可选】文章分类 |
keywords | 【可选】文章关键字 |
description | 【可选】文章描述 |
top_img | 【可选】文章頂部图片 |
cover | 【可选】文章缩略图(如果没有设置 top_img,文章页顶部将显示缩略图,可设为 false/图片地址/留空) |
comments | 【可选】显示文章评论模块(默认 true) |
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 配置) |
标签外挂(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 %} |