Front-matter

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

  • Page Front-matter 用於頁面配置
  • Post Front-matter 用於文章頁配置

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

Page Front-matter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
---
title:
date:
updated:
type:
comments:
description:
keywords:
top_img:
mathjax:
katex:
aside:
aplayer:
highlight_shrink:
random:
---

说明

寫法 解释
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)

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
25
26
---
title:
date:
updated:
tags:
categories:
keywords:
description:
top_img:
comments:
cover:
toc:
toc_number:
toc_style_simple:
copyright:
copyright_author:
copyright_author_href:
copyright_url:
copyright_info:
mathjax:
katex:
aplayer:
highlight_shrink:
aside:
abcjs:
---

说明

寫法 解释
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 )