页面配置

如无特殊说明,本页内容均写在front-matter中。

Front-matter

Front-matter 是文件最上方以 --- 分隔的区域,用于指定个别文件的变量。【详见官方文档】

字段含义值类型默认值
layout布局模版String-
title标题String-
date创建时间Date文件创建时间
updated更新日期Date文件修改时间
permalink覆盖文章网址String-
music内部音乐控件详见【music】-
keywords页面关键词String-
description页面描述、摘要String-
author作者Stringconfig.author
author_url作者链接Stringconfig.url
avatar作者头像Stringconfig.avatar
cover是否显示封面Booltrue
meta文章或页面的meta信息Bool, Arraytheme.meta
sidebar页面侧边栏Bool, Arraytheme.sidebar
body页面主体元素Arraytheme.body

layout=post时特有的字段:

字段含义值类型默认值
categories分类String, Array-
tag标签String, Array-
toc是否生成目录Booltrue
popular_posts显示推荐文章Booltrue
mathjax是否渲染公式Bool, Stringfalse
top是否置顶Boolfalse
thumbnail缩略图Stringfalse

layout=links时特有的字段:

字段含义值类型默认值
links友链详见【links】-

页面主体元素排列

默认是文章+评论:

1
2
3
---
body: [article, comments]
---

如果你想把推荐文章显示在评论前,可以这样写:

1
2
3
---
body: [article, related_posts, comments]
---

文章置顶

在Front-matter中设置以下值:

1
top: true

如果想自定义置顶标签的文字,可以直接设置为字符串,例如:

1
top: 近期更新

文章分类

多个分类有两种关系,一种是层级(等同于文件夹),一种是并列(等同于标签)。

多级分类

1
categories: [分类A, 分类B]

或者

1
2
3
categories:
- 分类A
- 分类B

并列分类

1
2
3
categories:
- [分类A]
- [分类B]

多级+并列分类

1
2
3
categories:
- [分类A, 分类B]
- [分类C, 分类D]

专属BGM

标题右边显示迷你音乐播放器,支持的字段有:servertypeid,取值详见【第三方服务 -> APlayer】。

示例

1
2
3
4
5
6
7
---
music:
enable: true # true(文章内和文章列表都显示) internal(只在文章内显示)
server: netease # netease(网易云音乐)tencent(QQ音乐) xiami(虾米) kugou(酷狗)
type: song # song (单曲) album (专辑) playlist (歌单) search (搜索)
id: 26664345 # 歌曲/专辑/歌单 ID
---

实际效果见:《文章专属BGM》

文章摘要

第一优先级是寻找正文中的<!--more-->,其前面的为摘要,可以显示在文章列表中,后面的是正文。
如果没有,则寻找Front-matter中的description字段,以其为摘要。
如果还没有,就没有摘要,文章列表会显示全文。

如果使用<!-- more -->来实现摘要,则<!-- more -->前后一定要有空行,不然可能导致显示错位。

1
2
3
4
5
这是摘要

<!-- more -->

这是正文

是否开启渲染MathJax

取值含义
false不渲染,默认值
true渲染
internal只在文章内部渲染,文章列表中不渲染
1
2
3
---
mathjax: true
---

如果公式仍无法正确渲染可以阅读@MicDZ大神的这篇文章:《在material-x上使用KaTeX》

自定义meta标签的顺序

文章顶部和底部的日期、分类、更新日期、标签、分享等属于meta标签,顶部的为header,底部的为footer

在Front-matter找到或者新增meta

1
2
3
4
5
6
7
8
---
# 默认的meta信息,文章中没有配置则按照这里的配置来显示,设置为false则不显示
# 其中,title只在header中有效,music和thumbnail无需在这里设置,文章中有则显示
# 如果tags放置在meta.header中,那么在post列表中不显示(因为卡片下方已经有了)
meta:
header: [title, author, date, categories, counter, top]
footer: [updated, tags, share]
---

像404、关于页面就可以完全隐藏:

1
2
3
4
5
---
meta:
header: false
footer: false
---

是否要显示封面

如果某个页面不需要封面,可以这样写:

1
2
3
---
cover: false
---

设置单独的作者信息

由于支持多作者维护,所以可以设置单独一篇文章的作者:

1
2
3
4
5
---
author: 另一个作者的名字
author_url: 另一个作者的主页
avatar: 另一个作者的头像
---

是否要显示侧边栏

如果某个页面不需要侧边栏,可以这样写:

1
2
3
---
sidebar: false
---

某个页面想指定显示某几个侧边栏,就这样写:

1
2
3
---
sidebar: [grid, toc, tags] # 放置任何你想要显示的侧边栏部件
---




评论

有疑问请前往本项目的【Issue】页面搜索问题,如果没有相关问题,点击【New issue】进行提问。