📖 本教程更新於 2020 年 10 月 28 日,教程的內容針對最新穩定版而更新(如果你是舊版,教程會有些出入,請留意)

🦋 Butterfly 已經更新到 3.3.0

如果有安裝這兩個插件的,請卸載掉,會導致主題報錯。
hexo-injecthexo-neat


Front-matter

Front-matter 是檔案最上方以 --- 分隔的區域,用於指定個別檔案的變數。

如果標注可選的參數,可根據自己需要添加,不用全部都寫在markdown裏

Page Front-matter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
---
title:
date:
updated:
type:
comments:
description:
keywords:
top_img:
mathjax:
katex:
aside:
aplayer:
highlight_shrink:
---
寫法解釋
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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
---
title:
date:
updated:
tags:
categories:
keywords:
description:
top_img:
comments:
cover:
toc:
toc_number:
copyright:
copyright_author:
copyright_author_href:
copyright_url:
copyright_info:
mathjax:
katex:
aplayer:
highlight_shrink:
aside:
---
寫法解釋
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配置)
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)

標籤頁

  1. 前往你的 Hexo 博客的根目錄

  2. 輸入hexo new page tags

  3. 你會找到source/tags/index.md這個文件

  4. 修改這個文件:

1
2
3
4
5
---
title: 標籤
date: 2018-01-05 00:00:00
type: "tags"
---

分類頁

  1. 前往你的 Hexo 博客的根目錄

  2. 輸入hexo new page categories

  3. 你會找到source/categories/index.md這個文件

  4. 修改這個文件:

1
2
3
4
5
---
title: 分類
date: 2018-01-05 00:00:00
type: "categories"
---

友情鏈接

為你的博客創建一個友情鏈接!

創建友情鏈接頁面

  1. 前往你的 Hexo 博客的根目錄
  2. 輸入 hexo new page link
  3. 你會找到source/link/index.md這個文件
  4. 修改這個文件:
1
2
3
4
5
---
title: 友情鏈接
date: 2018-06-07 22:17:49
type: "link"
---

友情鏈接添加

在Hexo博客目錄中的source/_data,創建一個文件link.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
- class_name: 友情鏈接
class_desc: 那些人,那些事
link_list:
- name: JerryC
link: https://jerryc.me/
avatar: https://jerryc.me/image/avatar.png
descr: 今日事,今日畢
- name: Hexo
link: https://hexo.io/zh-tw/
avatar: https://d33wubrfki0l68.cloudfront.net/6657ba50e702d84afb32fe846bed54fba1a77add/827ae/logo.svg
descr: 快速、簡單且強大的網誌框架

- class_name: 網站
class_desc: 值得推薦的網站
link_list:
- name: Youtube
link: https://www.youtube.com/
avatar: https://i.loli.net/2020/05/14/9ZkGg8v3azHJfM1.png
descr: 視頻網站
- name: Weibo
link: https://www.weibo.com/
avatar: https://i.loli.net/2020/05/14/TLJBum386vcnI1P.png
descr: 中國最大社交分享平台
- name: Twitter
link: https://twitter.com/
avatar: https://i.loli.net/2020/05/14/5VyHPQqR6LWF39a.png
descr: 社交分享平台

class_nameclass_desc支持html格式書寫,如不需要,也可以留空。

友情鏈接界面設置

由 2.2.0 起,友情鏈接界面可以由用户自己自定義,只需要在友情鏈接的md檔設置就行,以普通的Markdown格式書寫。

音樂

音樂界面使用了插件 hexo-tag-aplayer
使用方法請參考插件文檔

音樂頁面只是普通的page頁,按普通頁面操作生成就行。

以下內容可供選擇配置

注意: 仍需要安裝插件hexo-tag-aplayer

插件會在每一個文件都插入 js 和 css,為了避免這一情況,3.0 版本內置了 aplayer 需要的 css 和 js。

首先在Hexo根目錄_config裏配置asset_injectfalse

1
2
aplayer:
asset_inject: false

然後在你需要使用aplayer的頁面Front-matter添加

1
aplayer: true

這樣只會在需要aplayer的頁面插入js和css。

如何添加全局 Aplayer 播放,請參考 這篇文章

電影

電影界面使用了插件 hexo-douban
使用方法請參考插件的文檔

注意: hexo-douban 會主動生成頁面,所以不需要自己創建。對應網頁的top_img可以在主題配置文件中修改。

圖庫

圖庫頁面只是普通的頁面,你只需要hexo n page xxxxx 創建你的頁面就行

然後使用標簽外掛 galleryGroup,具體用法請查看對應的內容。

1
2
3
4
5
<div class="gallery-group-main">
{% galleryGroup '壁紙' '收藏的一些壁紙' '/Gallery/wallpaper' https://i.loli.net/2019/11/10/T7Mu8Aod3egmC4Q.png %}
{% galleryGroup '漫威' '關於漫威的圖片' '/Gallery/marvel' https://i.loli.net/2019/12/25/8t97aVlp4hgyBGu.jpg %}
{% galleryGroup 'OH MY GIRL' '關於OH MY GIRL的圖片' '/Gallery/ohmygirl' https://i.loli.net/2019/12/25/hOqbQ3BIwa6KWpo.jpg %}
</div>

子頁面

子頁面也是普通的頁面,你只需要hexo n page xxxxx 創建你的頁面就行

然後使用標簽外掛 gallery,具體用法請查看對應的內容。

1
2
3
4
5
6
7
8
9
10
{% gallery %}
![](https://i.loli.net/2019/12/25/Fze9jchtnyJXMHN.jpg)
![](https://i.loli.net/2019/12/25/ryLVePaqkYm4TEK.jpg)
![](https://i.loli.net/2019/12/25/gEy5Zc1Ai6VuO4N.jpg)
![](https://i.loli.net/2019/12/25/d6QHbytlSYO4FBG.jpg)
![](https://i.loli.net/2019/12/25/6nepIJ1xTgufatZ.jpg)
![](https://i.loli.net/2019/12/25/E7Jvr4eIPwUNmzq.jpg)
![](https://i.loli.net/2019/12/25/mh19anwBSWIkGlH.jpg)
![](https://i.loli.net/2019/12/25/2tu9JC8ewpBFagv.jpg)
{% endgallery %}

如果你想要使用 /photo/ohmygirl 這樣的鏈接顯示你的圖片內容

你可以把創建好的 ohmygirl整個文件夾移到 photo文件夾裏去

説説

支持 3.2.0 以上版本

請注意: 由於 Artitalk 對 Pjax 支持並不完善,如果你使用 Valine 評論,請把説説頁面添加到 pjax 的 exclude 去。

不然會引起 Artitalk 和 Valine 都加載出錯。

主題內置了 Artitalk

這是一款基於 LeanCloud 實現的可實時發佈説説/微語的插件

創建頁面

通過 hexo new page xxxx 創建一個頁面

打開創建的 md 文件, 在 Front-matter 添加 type: artitalk

1
2
3
4
5
---
title: xxxx
date: 2020-09-16 00:58:58
type: artitalk
---

配置文件

【重要】請參照 Artitalk 的文檔( leancloud-的相關準備 )配置 leancloud

然後修改 主題配置文件

1
2
3
4
5
6
# Artitalk
# see https://artitalk.js.org/
artitalk:
appId: xxxxx
appKey: xxxxx
option:

Artitalk 提供了很多可選參數配置,如果你想配置的話,請寫在 option 裏

例如:

1
2
3
option:
serverURL: xxxxx
lang: zh

404頁面

主題內置了一個簡單的404頁面,可在設置中開啟

本地預覽時,訪問出錯的網站是不會跳到404頁面的。

如需本地預覽,請訪問http://localhost:4000/404.html

1
2
3
4
5
# A simple 404 page
error_404:
enable: true
subtitle: "頁面沒有找到"
background:

🛠 Butterfly 安裝文檔(三) 主題配置