Markdown的高级语法(1)
以下内容参考 标签外挂
仅供学习使用🎃🎃🎃
标签外挂是 Hexo 独有的功能,并不是标准的 Markdown 格式。
以下的写法,只适用于 Butterfly 主题,用在其它主题上不会有效果,甚至可能会报错。使用前请留意
标签外挂虽然能为主题带来一些额外的功能和 UI 方面的强化,但是,标签外挂也有明显的限制,使用时请留意。
Tabs
Tabs
移植于 next 主题
使用方法:
1 | {% tabs Unique name, [index] %} |
参数 | 解释 |
---|---|
Unique name | tabs 区块标签的唯一名称,不包含逗号。将用于每个选项卡的 #id 前缀,并附加其索引号。若名称中有空格,生成 #id 时会将空格替换为短横线。仅对当前文章/页面的 URL 必须唯一! |
[index] | 【可选】活动选项卡的索引号。如果未指定,将选择第一个选项卡(1)。如果索引为 -1,则不会选择任何选项卡,类似于折叠内容。可选参数。 |
[Tab caption] | 当前选项卡的标题。如果未指定标题,将使用唯一名称和选项卡索引后缀作为选项卡标题。如果未指定标题,但指定了图标,标题将为空。 |
[@icon] | 【可选】FontAwesome 图标名称(全名,如 ‘fas fa-font’)。可以有或没有空格;例如 ‘Tab caption @icon’ 与 ‘Tab caption@icon’ 类似。 |
1 | {% tabs test1 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
1 | {% tabs test2, 3 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
1 | {% tabs test3, -1 %} |
This is Tab 1.
This is Tab 2.
This is Tab 3.
1 | {% tabs test4 %} |
tab 名字为第一个 Tab
只有图标 没有 Tab 名字
名字+icon
Note (Bootstrap Callout)
Note (Bootstrap Callout)
移植于 next 主题,并进行修改。
1 | note: |
参数 | 解释 |
---|---|
style | 【可选】标签样式(simple/modern/flat/disabled) |
icons | 【可选】是否显示 icon |
border_radius | 【可选】边框圆角 |
light_bg_offset | 【可选】背景色偏移量 |
Note 标签外挂有两种用法
icons
和 light_bg_offset
只对方法一生效
1 | {% note [class] [no-icon] [style] %} |
参数 | 解释 |
---|---|
class | 【可选】标识,不同的标识有不同的配色( default / primary / success / info / warning / danger ) |
no-icon | 【可选】不显示 icon |
style | 【可选】可以覆盖配置中的 style(simple/modern/flat/disabled) |
1 | {% note simple %} |
默认 提示块标签
default 提示块标签
primary 提示块标签
success 提示块标签
info 提示块标签
warning 提示块标签
danger 提示块标签
1 | {% note modern %} |
默认 提示块标签
default 提示块标签
primary 提示块标签
success 提示块标签
info 提示块标签
warning 提示块标签
danger 提示块标签
1 | {% note flat %} |
默认 提示块标签
default 提示块标签
primary 提示块标签
success 提示块标签
info 提示块标签
warning 提示块标签
danger 提示块标签
1 | {% note disabled %} |
默认 提示块标签
default 提示块标签
primary 提示块标签
success 提示块标签
info 提示块标签
warning 提示块标签
danger 提示块标签
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) |
1 | {% note 'fab fa-cc-visa' simple %} |
你是刷 Visa 还是 UnionPay
2021 年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
1 | {% note 'fab fa-cc-visa' modern %} |
你是刷 Visa 还是 UnionPay
2021 年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
1 | {% note 'fab fa-cc-visa' flat %} |
你是刷 Visa 还是 UnionPay
2021 年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
1 | {% note 'fab fa-cc-visa' disabled %} |
你是刷 Visa 还是 UnionPay
2021 年快到了….
小心开车 安全至上
这是三片呢?还是四片?
你是刷 Visa 还是 UnionPay
剪刀石头布
前端最讨厌的浏览器
1 | {% note no-icon %} |
Mermaid
Mermaid
使用 mermaid 标签可以绘制 Flowchart(流程图)、Sequence diagram(时序图 )、Class Diagram(类别图)、State Diagram(状态图)、Gantt(甘特图)和 Pie Chart(圆形图),具体可以查看mermaid 文档
1 | # Mermaid |
写法:
1 | {% mermaid %} |
例子:
1 | {% mermaid %} |
pie title Key elements in Product X "Calcium" : 42.96 "Potassium" : 50.05 "Magnesium" : 10.01 "Iron" : 5
Button
Button
3.0 以上适用
使用方法:
1 | {% btn [url],[text],[icon],[color] [style] [layout] [position] [size] %} |
参数 | 解释 |
---|---|
url | 【必须】链接地址 |
text | 【必须】按钮文字 |
icon | 【可选】图标 |
color | 【可选】按钮背景顔色(默认style时)按钮字体和边框顔色(outline 时) 配置:default/blue/pink/red/purple/orange/green |
style | 【可选】按钮样式 默认实心 配置: outline/留空 |
layout | 【可选】按钮佈局 默认为 line 配置: block/留空 |
position | 【可选】按钮位置 前提是设置了layout为block默认为左边 配置:center/right/留空 |
size | 【可选】按钮大小 配置:larger/留空 |
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 %} |
1 | {% btn 'https://butterfly.js.org/',Butterfly,far fa-hand-point-right,larger %} |
1 | <div class="btn-center"> |
InlineImg
InlineImg
主题中的图片都是默认以块级元素
显示,如果你想以内联元素
显示,可以使用这个标签外挂。
1 | {% inlineImg [src] [height] %} |
参数 | 解释 |
---|---|
src | 图片链接 |
height | 【可选】图片高度限制 |
例子:
1 | 你看她长得漂亮不 |
你看她长得漂亮不
我觉得很漂亮
Label
Label
由于 hexo 的渲染限制, 在段落开头使用 label 标签外挂会出现一些问题。例如:连续开头使用 label 标签外挂的段落无法换行
建议不要在段落开头使用 label 标签外挂
1 | {% label text color %} |
参数 | 解释 |
---|---|
text | 文字 |
color | 【可选】背景颜色,默认为default default/blue/pink/red/purple/orange/green |
例子:
1 | 臣亮言:{% label 先帝 %}创业未半,而{% label 中道崩殂 blue %}。今天下三分,{% label 益州疲敝 pink %},此诚{% label 危急存亡之秋 red %}也!然侍衞之臣,不懈于内;{% label 忠志之士 purple %},忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。 |
臣亮言:先帝 创业未半,而中道崩殂 。今天下三分,益州疲敝 ,此诚危急存亡之秋 也!然侍衞之臣,不懈于内;忠志之士 ,忘身于外者,盖追先帝之殊遇,欲报之于陛下也。诚宜开张圣听,以光先帝遗德,恢弘志士之气;不宜妄自菲薄,引喻失义,以塞忠谏之路也。
宫中、府中,俱为一体;陟罚臧否,不宜异同。若有作奸 、犯科 ,及为忠善者,宜付有司,论其刑赏,以昭陛下平明之治;不宜偏私,使内外异法也。
Timeline
Timeline
4.0.0 以上支持
1 | {% timeline title,color %} |
参数 | 解释 |
---|---|
title | 标题/时间线 |
color | timeline 颜色 default(留空) / blue / pink / red / purple / orange / green |
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
这是测试页面
ABCJS 乐谱
ABCJS
在页面上渲染乐谱
1 | # abcjs (乐谱渲染) |
参数 | 解释 |
---|---|
enable | 是否启用 ABCJS |
per_page | 是否每页都加载 ABCJS, 如果设爲 false, 在你使用 ABCJS 时,你需要在使用 ABCJS 的页面 Front-matter 添加 abcjs: true |
写法:
1 | {% score %} |
例子:
1 | {% score %} |
Series 系列文章
Series
在页面上显示系列文章
1 | series: |
参数 | 解释 |
---|---|
enable | 是否启用 series |
orderBy | 排序方式,默认为 title, 可选 title / date |
order | 排序方式,默认为 1, 可选 1 (升序) / -1(降序) |
number | 显示序列号 |
写法:
1 | {% series %} |
在文章的front-matter
上添加参数 series,并给与一个标识
使用此标签外挂,会把相同标识的文章以列表的形式展示
如果不写 series 标识,则默认为你使用此标签外挂所在的文章的 series 标识
例子:
1 | --- |
如有需要,请查阅其它笔记:
Gallery 相册图库
Gallery
一个图库集合。
写法:
1 | <div class="gallery-group-main"> |
参数 | 解释 |
---|---|
name | 图库名字 |
description | 图库描述 |
link | 连接到对应相册的地址 |
img-url | 图库封面的地址 |
例子:
1 | <div class="gallery-group-main"> |
区别于旧版的 Gallery 相册,新的 Gallery 相册会自动根据图片长度进行排版,书写也更加方便,与 markdown 格式一样。可根据需要插入到相应的 md。
写法;
1 | {% gallery [lazyload],[rowHeight],[limit] %} |
参数 | 解释 |
---|---|
lazyload | 【可选】点击按钮加载更多图片,填写 true/false。默认为 false 。 |
rowHeight | 【可选】图片显示的高度,如果需要一行显示更多的图片,可设置更小的数字。默认为 220 。 |
limit | 【可选】每次加载多少张照片。默认为 10 。 |
例子:
1 | {% gallery %} |
写法:
1 | {% gallery url,[link],[lazyload],[rowHeight],[limit] %} |
参数 | 解释 |
---|---|
url | 【必须】 识别词 |
link | 【必须】远程的 json 链接 |
lazyload | 【可选】点击按钮加载更多图片,填写 true/false。默认为 false 。 |
rowHeight | 【可选】图片显示的高度,如果需要一行显示更多的图片,可设置更小的数字。默认为 220 。 |
limit | 【可选】每次加载多少张照片。默认为 10 。 |
有三个参数,url
是必须存在的,alt
和 title
可有,也可没有。
1 | [ |
1 | {% gallery url,https://xxxx.com/sss.json %} |
Tag-hide
2.2.0 以上提供
请注意,tag-hide 内的标签外挂 content 内都不建议有 h1 - h6 等标题。因为 Toc 会把隐藏内容标题也显示出来,而且当滚动屏幕时,如果隐藏内容没有显示出来,会导致 Toc 的滚动出现异常。
如果你想把一些文字、内容隐藏起来,并提供按钮让用户点击显示。可以使用这个标签外挂。
inline
在文本里面添加按钮隐藏内容,只限文字
( content 不能包含英文逗号,可用‚
)
1 | {% hideInline content,display,bg,color %} |
参数 | 解释 |
---|---|
content | 文本内容 |
display | 【可选】按钮显示的文字 |
bg | 【可选】按钮的背景颜色 |
color | 【可选】按钮文字的颜色 |
例子
1 | 哪个英文字母最酷? {% hideInline 因为西装裤(C装酷),查看答案,#FF7242,#fff %} |
哪个英文字母最酷?
门里站着一个人?block
独立的 block 隐藏内容,可以隐藏很多内容,包括图片,代码块等等
( display 不能包含英文逗号,可用‚
)
1 | {% hideBlock display,bg,color %} |
参数 | 解释 |
---|---|
content | 文本内容 |
display | 【可选】按钮显示的文字 |
bg | 【可选】按钮的背景颜色 |
color | 【可选】按钮文字的颜色 |
例子
1 | 查看答案 |
查看答案
2.3.0 以上支持
如果你需要展示的内容太多,可以把它隐藏在收缩框里,需要时再把它展开。
( display 不能包含英文逗号,可用‚
)
1 | {% hideToggle display,bg,color %} |
参数 | 解释 |
---|---|
display | 显示的文字 |
bg | 【可选】背景颜色 |
color | 【可选】文字的颜色 |
例子
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
如有需要,请查阅其它笔记: