基本配置

多语言支持

字段:language

在博客根目录的配置文件中:

1
2
3
4
5
language:
- zh-CN
- en
- zh-HK
- zh-TW

博客将按照给定的优先级显示语言,目前支持的语言只有这4种,如需其他语言,欢迎提供翻译。

站点信息

字段:title(网站标题)

在博客根目录的配置文件中:

1
title: my blog

字段:favicon(网站图标)

在博客根目录的配置文件中:

1
favicon: https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicon.ico

Import

字段:import 可以在无需修改主题文件的情况下在head和body中添加各种标签。

目前支持4个字段,metalink对应head中的<meta><link>标签。script可以在body末尾导入js文件。(如果还有什么需求可以在下方留言)

这是我的import示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
# 全局导入
import:
meta:
- "<meta name='theme-color' content='#FFFFFF'>"
- "<meta name='msapplication-TileColor' content='#1BC3FB'>"
- "<meta name='msapplication-config' content='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicons/browserconfig.xml'>"
link:
- "<link rel='shortcut icon' type='image/x-icon' href='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicon.ico'>"
- "<link rel='icon' type='image/x-icon' sizes='32x32' href='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicons/favicon-32x32.png'>"
- "<link rel='apple-touch-icon' type='image/png' sizes='180x180' href='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicons/apple-touch-icon.png'>"
- "<link rel='mask-icon' color='#1BC3FB' href='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicons/safari-pinned-tab.svg'>"
- "<link rel='manifest' href='https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/favicon/favicons/site.webmanifest'>"
# script:

社交信息

字段:social

在博客根目录的配置文件中:

1
2
3
4
5
6
7
8
# 页脚社交信息
social:
- icon: fas fa-envelope
url: mailto:[email protected]
- icon: fab fa-github
url: https://github.com/xaoxuu
- icon: fas fa-music
url: https://music.163.com/#/user/home?id=63035382

这些社交按钮也会同时出现在侧边栏头像下方,可以在侧边栏的配置中设置不显示。

导航栏

字段:menu

在博客根目录的配置文件中:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 导航栏,建议以/结尾。
menu:
- name: home
icon: fas fa-home
url: https://xaoxuu.com/
- name: blogs
icon: fas fa-rss
url: /
- name: archives
icon: fas fa-archive
url: archives/
- name: friends
icon: fas fa-users
url: friends/

其中 icon 是 fontawesome 图标名,你要显示什么图标,去 fontawesome.com 找免费版的就可以了。

侧边栏

字段:widgets 侧边栏小部件显示什么、显示多少个、顺序如何完全由博主给定的顺序决定。

通用字段

如无特殊说明,所有的小部件都至少支持下面这些通用字段:

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型详见【widget枚举值】plain
enable是否启用Booltrue
icon左上角的图标String‘’
title标题String‘’
more右上角的按钮详见【more】-

字段:widget 代表小部件的类型,取值有以下几种:

取值含义
author博主信息小部件
category文章分类小部件
tagcloud标签云小部件
toc文章目录小部件
music音乐小部件
plain纯文本小部件
list列表小部件

字段:more 小部件右上角的按钮

字段含义是否必须
icon按钮图标
url按钮的链接
animate按钮hover时的动画

字段:animate 取值有以下几种:

取值含义
rotate90顺时针旋转90度

博主信息小部件

博主信息小部件不支持上述的通用字段中的icontitlemore,以下只显示博主信息小部件特有字段:

字段含义是否必须值类型默认值
avatar头像String‘’
title标题String‘’
body正文String‘’
social社交信息Boolfalse

纯文本小部件

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型必须是’plain’plain
body正文内容,支持markdown语法。markdown‘’

列表小部件

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型必须是’list’plain
rows每一行元素详见【rows】-

rows:

字段含义是否必须值类型默认值
name名称String‘’
img方形图片否,不设置时是空白String‘’
avatar圆形图片否,不设置时是空白String‘’
icon图标否,不设置时是空白String‘’
url链接String‘’
desc描述文字String‘’

注意:一行的img、avatar和icon字段如果提供了多个,最多只会显示一个。

文章分类小部件

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型必须是’category’plain

标签云小部件

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型必须是’tagcloud’plain

音乐小部件

字段含义是否必须值类型默认值
widget表示这个小部件是什么类型必须是’music’plain

字段以及取值详见【第三方服务 -> APlayer】

TOC目录小部件

没有特有字段,并且不支持通用字段中的more,因为其右上角的按钮具有特殊作用。

侧边栏示例

在博客根目录的配置文件中:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# 侧边栏小部件
widgets:
- widget: author
avatar: https://cdn.jsdelivr.net/gh/xaoxuu/[email protected]/avatar/avatar.png
jinrishici: 柳暗花明又一村
social: true
- widget: toc
- widget: plain
icon: fas fa-bullhorn
title: 注意啦~
body: '本站使用 [Material X](https://xaoxuu.com/wiki/material-x/) 作为主题,喜欢这个主题的朋友可以阅读文档进行安装哦,超喜欢的话还可以安利给身边的朋友哦~'
more:
icon: fas fa-question-circle
url: https://xaoxuu.com/wiki/material-x/
- widget: category
- widget: tagcloud
- widget: list
icon: fas fa-medal
title: 精选项目
more:
icon: fas fa-arrow-right
url: https://xaoxuu.com/projects/
rows:
- name: AXKit
desc: iOS开源库
icon: fas fa-cube
url: https://xaoxuu.com/wiki/axkit/
- name: NoticeBoard
desc: iOS开源库
icon: fas fa-cube
url: https://xaoxuu.com/wiki/noticeboard/
- name: HeartMate
desc: iOS应用程序
icon: fas fa-heartbeat
url: https://xaoxuu.com/heartmate/
- name: Material X
desc: Hexo博客主题
icon: fas fa-cube
url: https://xaoxuu.com/wiki/material-x/
- widget: list
icon: fas fa-link
title: 特别链接
rows:
- name: 关于我 / 留言板
icon: fas fa-comment-dots
url: https://xaoxuu.com/about/
- widget: related_posts
- widget: music
icon: fas fa-compact-disc
title: "最近在听"
more:
icon: far fa-heart
url: https://music.163.com/#/user/home?id=63035382
server: netease # netease(网易云音乐)tencent(QQ音乐) xiami(虾米) kugou(酷狗)
type: playlist # song (单曲) album (专辑) playlist (歌单) search (搜索)
id: 2615636388 # 歌曲/专辑/歌单 ID

页脚文字

字段:footer

在博客根目录的配置文件中:

1
footer: '这是页脚文字,支持**markdown**语法。'



评论