Butterfly主题配置之Font-matter
引入
因为平时配置很少用,但是要用的时候每次都要到Jerry大佬的文档里翻就很麻烦,这里做个复刻,以便翻阅。
Butterfly主题配置之Font-matter
Font-matter
Front-matter 是 markdown 文件最上方以 —- 分隔的區域,用於指定個別檔案的變數。
- Page Front-matter 用於頁面配置
- Post Front-matter 用於文章頁配置
如果標注可選的參數,可根據自己需要添加,不用全部都寫在markdown裏
Page Font-matter
1 | --- |
写法 | 解释 |
---|---|
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的配置) |
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) |
友情链接相关
- 4.0.0开始支持远程加载友情链接,只支持json拉取
- 注意: 選擇遠程加載後,本地生成的方法會無效。
Butterfly主题配置之标签外挂
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
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"> |
label
3.7.5 及以上版本適用
高亮所需的文字
1 | {% label text color %} |
參數 | 解釋 |
---|---|
text | 文字 |
color | 【可選】背景顏色,默認為 defaultdefault/blue/pink/red/purple/orange/green |
Demo
1 | 臣亮言:{% label 先帝 %}創業未半,而{% label 中道崩殂 blue %}。今天下三分,{% label 益州疲敝 pink %},此誠{% label 危急存亡之秋 red %}也!然侍衞之臣,不懈於內;{% label 忠志之士 purple %},忘身於外者,蓋追先帝之殊遇,欲報之於陛下也。誠宜開張聖聽,以光先帝遺德,恢弘志士之氣;不宜妄自菲薄,引喻失義,以塞忠諫之路也。 |
臣亮言:先帝 創業未半,而中道崩殂 。今天下三分,益州疲敝 ,此誠危急存亡之秋 也!然侍衞之臣,不懈於內;忠志之士 ,忘身於外者,蓋追先帝之殊遇,欲報之於陛下也。誠宜開張聖聽,以光先帝遺德,恢弘志士之氣;不宜妄自菲薄,引喻失義,以塞忠諫之路也。
宮中、府中,俱為一體;陟罰臧否,不宜異同。若有作奸 、犯科 ,及為忠善者,宜付有司,論其刑賞,以昭陛下平明之治;不宜偏私,使內外異法也。
flink
4.1.0 支持
可在任何界面插入類似友情鏈接列表效果
內容格式與友情鏈接界面一樣,支持 yml 格式
1 | {% flink %} |
Demo
1 | {% flink %} |