butterfly主题front-matter设置说明 | jianerssr的个人小屋

type

status

date

slug

summary

前言

本节整合了butterfly主题文档关于front-matter设置的所有说明

Front-matter 是 markdown 文件最上方以 --- 分隔的区域，用于文件最基本的配置。其中：

page Front-matter 用于页面配置。

Post Front-matter 用于文章页配置。

1. Post Front-matter

参数	说明	备注
`title`	[必需]文章标题	ㅤ
`date`	[必需]文章创建日期	ㅤ
`updated`	[可选]文章更新日期	ㅤ
`tags`	[可选]文章标签	注3.1
`categories`	[可选]文章分类	注3.1
`keywords`	[可选]文章关键字	ㅤ
`description`	[可选]文章描述	注3.3
`top_img`	[可选]文章顶部图片	注3.4
`comments`	[可选]显示文章页面评论模块(默认 `true`)	ㅤ
`cover`	[可选]文章缩略图	注3.4
`toc`	[可选]显示文章`TOC`	注3.7
`toc_number`	[可选]显示`toc_number`	注3.7
`toc_style_simple`	[可选]显示 `toc` 简洁模式	注3.7
`copyright`	[可选]显示文章版权模块	注3.6
`copyright_author`	[可选]文章版权模块的文章作者	注3.6
`copyright_author_href`	[可选]文章版权模块的文章作者链接	注3.6
`copyright_url`	[可选]文章版权模块的文章连结链接	注3.6
`copyright_info`	[可选]文章版权模块的版权声明文字	注3.6
`mathjax`	[可选]显示`mathjax`	注3.8
`katex`	[可选]显示`katex`	注3.8
`aplayer`	[可选]在需要的页面加载`aplayer`的`js`和`css`	注3.9
`highlight_shrink`	[可选]配置代码框是否展开(`true/false`)	注3.2
`aside`	[可选]显示侧边栏 (默认 `true`)	ㅤ
`sticky`	[可选]是否置顶	注3.5

2. page Front-matter

参数	说明	备注
`title`	[必需]页面标题	ㅤ
`date`	[必需]页面创建日期	ㅤ
`updated`	[可选]页面更新日期	ㅤ
`type`	[必需]标签、分类和友情链接三个页面需要配置	ㅤ
`comments`	[可选]显示页面评论模块(默认 `true`)	ㅤ
`description`	[可选]页面描述	注3.3
`keywords`	[可选]页面关键字	ㅤ
`top_img`	[可选]页面顶部图片	注3.4
`mathjax`	[可选]显示`mathjax`	注3.8
`katex`	[可选]显示`katex`	注3.8
`aside`	[可选]显示侧边栏 (默认 `true`)	ㅤ
`aplayer`	[可选]在需要的页面加载`aplayer`的`js`和`css`	注3.9
`highlight_shrink`	[可选]配置代码框是否展开(`true/false`)(默认为设置中`highlight_shrink`的配置)	注3.2

3.部分参数用法

3.1 tags 、categories用法

标记都是在同一层次结构级别上定义的，因此它们的显示顺序并不重要。

分类是有层级的，因此，在设置分类时应特别注意。

3.2 highlight_shrink用法

当主题配置文件中的 highlight_shrink 设为true时，可在front-matter添加highlight_shrink: false来单独配置文章展开代码框。

当主题配置文件中的 highlight_shrink 设为false时，可在front-matter添加highlight_shrink: true来单独配置文章收缩代码框。

总而言之，默认为主题设置中highlight_shrink的配置，但可以在Front-matter配置，这里权限更高。

3.3 description用法

对于post：用于主页文章下面的一段描述，本网站选择的是，如果写了description，主页文章描述就是这个，如果没写，就自动节选。

对于page：描述页面。

3.4 top_img 、cover用法

page页面顶部图的获取顺序：

各自配置的 top_img > 配置文件的 default_top_img。

post文章页顶部图的获取顺序：

各自配置的 top_img > cover > 配置文件的 default_top_img。

如果没有设置top_img,文章页顶部将显示缩略图，可设top_img``cover为false/图片地址/留空。另外，cove为文章封面，就是主页文章旁边显示的那张图片，与文章内的顶部图还是有区别的。

文章封面的获取顺序 Front-matter 的 cover > 配置文件的 default_cover > false。

3.5 sticky用法

文章置顶功能。可以直接在文章的front-matter区域里添加sticky: 1属性来把这篇文章置顶。数值越大，置顶的优先级越大。

3.6 文章版权相关Front-matter用法

文章版权信息默认为主题设置中post_copyright的enable配置，但也可以在这里设置，此处优先级更高。

如果有文章（例如：转载文章）不需要显示版权，可以在文章Front-matter处单独设置copyright: false。

如果需要对单独文章设置版权信息，可以应在文章Front-matter处单独设置。

3.7 目录相关Front-matter用法

一般来说，toc默认为主题设置中toc的enable配置，toc_number默认为主题设置中toc的number配置，toc_style_simple也是如此。但也可以在文章md文件的头部加入toc_number和toc，并配置true或者false即可。主题会优先判断文章Markdown的Front-matter是否有配置，如有，则以Front-matter的配置为准。否则，以主题配置文件中的配置为准。

toc是否在文章页显示目录true/false。

toc_number是否显示章节数true/false。

toc_style_simple是否开启简介模式（侧边栏只显示toc，只对文章页有效）true/false。

3.8 mathjax KaTex用法

当设置mathjax的per_page: false时，才需要配置，默认 false。

当设置katex的per_page: false时，才需要配置，默认 false。

本博客暂未配置mathjax和katex，因此没用。

3.9 aplayer用法

主要为是否在该页面开启音乐等全局吸底，不想就开输入false，本博客没有配置，没用。