Front-matter
Page Front-matter
如果标注可选的参数,可根据自己需要添加,不用全部都写在 markdown 里
--- |
写法 | 解释 |
---|---|
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
--- |
写法 | 解释 |
---|---|
title | 【必需】文章标题 |
date | 【必需】文章创建日期 |
updated | 【可选】文章更新日期 |
tags | 【可选】文章标籤 |
categories | 【可选】文章分类 |
keywords | 【可选】文章关键字 |
description | 【可选】文章描述 |
top_img | 【可选】文章顶部图片 |
cover | 【可选】文章缩略图 (如果没有设置 top_img, 文章页顶部将显示缩略图,可设为 false / 图片地址 / 留空) |
comments | 【可选】显示文章评论模块 (默认 true) |
copyright | 【可选】显示文章版权模块 (默认为设置中 post_copyright 的 enable 配置) |
copyright_author | 【可选】文章版权模块的文章作者 |
copyright_author_href | 【可选】文章版权模块的文章作者链接 |
copyright_url | 【可选】文章版权模块的文章连结链接 |
copyright_info | 【可选】文章版权模块的版权声明文字 |
highlight_shrink | 【可选】配置代码框是否展开 (true/false)(默认为设置中 highlight_shrink 的配置) |
Note
default 提示块标籤
success 提示块标籤
info 提示块标籤
warning 提示块标籤
danger 提示块标籤
顶部图
顶部图有 2 种配置:具体 url 和(留空,true 和 false,三个效果一样)
page页
当具体url时
主页的顶部图可以在 Butterfly.yml 设置 index_img
archives 页的顶部图可以在 Butterfly.yml 设置 archive_img
其他 page 页的顶部图可以在各自的 md 页面设置 front-matter 中的 top_img
页面如果没有设置各自的 top_img,则会显示 default_top_img 图片
当顶部图留空,true 和 false
主页会显示纯颜色的顶部图
其他 page 的顶部图没有设置时,也会显示纯颜色的顶部图
post页
post 页的顶部图会优先显示各自 front-matter 中的 top_img, 如果没有设置,则会缩略图(即各自 front-matter 中的 cover),如果没有则会显示显示 default_top_img 图片
文章置顶
要为文章置顶,你需要安装插件 (hexo-generator-index-pin-top 或者 hexo-generator-indexed)
如果使用 hexo-generator-index-pin-top, 需要先卸载掉 hexo-generator-index,然后在文章的 front-matter 区域里添加 top: true 属性来把这篇文章置顶
如果使用 hexo-generator-indexed, 需要先卸载掉 hexo-generator-index,然后在文章的 front-matter 区域里添加 sticky: 1 属性来把这篇文章置顶。数值越大,置顶的优先级越大
文章封面
文章的 markdown 文档上,在 Front-matter 添加 cover, 并填上要显示的图片地址。
如果不配置 cover, 可以设置显示默认的 cover.
如果不想在首页显示 cover, 可以设置为 false
配置 butterfly.yml
cover: |
当配置多张图片时,会随机选择一张作为 cover. 此时写法应为
default_cover: |