Front-matter 是文件开头的 YAML 或 JSON 代码块,用于配置写作设置。 以 YAML 格式书写时,Front-matter 以三个破折号结束;以 JSON 格式书写时,Front-matter 以三个分号结束。

使用方式

YAML

1
2
3
4
---
title: Hello World
date: 2013/7/13 20:46:25
---

JSON

1
2
3
"title": "Hello World",
"date": "2013/7/13 20:46:25"
;;;

文章的 Front-matter

写法解释
title【必需】文章标题 文章的文件名
date【必需】文章创建日期
updated【可选】文章更新日期
tags【可选】文章标签
categories【可选】文章分类
sticky【可选】文章置顶,sticky: 1属性来把这篇文章置顶。数值越大,置顶的优先级越大。
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 配置)
1
2
3
4
---
title: Hello World
date: 2013/7/13 20:46:25
---

页面的 Front-matter

参数解释
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)
limit【可选】配置説説显示数量
limit.type【可选】配置説説显示数量的类型 (date 或者 num)
limit.value【可选】配置説説显示数量的值
1
2
3
4
5
---
title: 标签
date: 2018-01-05 00:00:00
type: 'tags'
---