Front-matter

Front-matter是Markdown文件开头的YAML格式的元数据块,用于配置页面的属性。

主题官方文档:Butterfly 文档(二) 主题页面

文章 Post

1
2
3
4
5
6
7
8
9
10
11
12
13
14
---
title: 文章标题 # 标题
abbrlink: article # 页面名,文章的短链接
date: 2023-10-01
description: 文章描述
categories: 分类
tags:
- 标签1
- 标签2
swiper_index: # 置顶,数值越大越靠前
message: # 加密问题
password: # 密码
wrong_pass_message: # 密码错误时的提示
---
参数说明
参数类型/格式默认值说明
titlestr无题【必选】文章标题
abbrlinkstrauto【必选】文章的短链接
dateYYYY-MM-DDauto【必选】文章发布日期
descriptionstrNone文章描述
categoriesstrNone文章分类
tagslist[str]None文章标签
swiper_indexintNone置顶文章轮播,数值越大越靠前
messagestrNone加密问题提示
passwordstrNone加密文章密码
wrong_pass_messagestrNone密码错误时的提示信息
不常用参数
参数类型/格式默认值说明
updatedYYYY-MM-DDauto文章最后更新时间
keywordsstr/list[str]None文章关键词
top_imgimg_urlrand文章顶部图片
coverimg_urlrand文章封面图片
commentsbooltrue启用评论功能
asidebooltrue启用侧边栏
mathjaxboolconfig.mathjax.per_page=true
本项无效
启用数学公式
tocboolconfig.toc.post
(true)
启用文章目录
toc_numberboolconfig.toc.number
(false)
文章目录编号
copyrightboolconfig.post_copyright.enable
(true)
末尾版权信息模块
copyright_authorstrconfig.author版权模块作者名
copyright_author_hrefstrNone版权模块作者链接
copyright_urlstrNone版权模块文章链接
copyright_infostrNone版权模块声明文字

项目结构

source

```plaintext
source
├── _data
│ ├── link.yml: 友链配置
│ └── menu.yml
├── _drafts: 草稿
├── _posts: 文章
├── about: “关于”页面
├── assets: 静态资源
| ├── avatars: 头像