本站文章书写规范参考指南。

文章开头类似如下的语法：

1
2
3
4
5
6
7
8
---
title:
date:
top_img:
cover:
categories:
tags:
---

在Hexo中叫做Front-Matter，通过它你可以限定文章的一些行为。

所以本文重点说明Hexo的Front-Matter和文章书写格式

Front-Matter中必要的信息

title

文章标题，内置中文支持

date

文章撰写时间

top_img

当前文章页面顶部大图，可以使用本地图片的相对路径，也可以为外站链接。

1
2
站内： top_img': /images/site/example.jpg   # 对应存放在 /source/images/site/example.jpg
站外： top_img: https://static.zkqiang.cn/example.jpg

NOTE: 图片大小建议压缩到 1MB 以内，否则会严重拖慢页面加载

cover - 文章首页缩略图

站点主页中文章索引图片，也就是首页文章的缩略图；依然可以使用本地或者远程图片资源。

使用Front-Matter形式配置，与top_img配置类似，格式如下：

1
cover: /images/somewhere/example.jpg

categories

文章归档种类，一般认为，categories用来描述文章作者的知识结构树，文章应该明确属于某一个领域，哪怕它已经借鉴了其他领域的知识。
分类包含层级关系，一般一个文章属于一个种类，如果使用列表方式存放多个类别，那就会形成类别树，如：

1
2
3
categories
  - docker
  - gcc

对应到(可以联想两级目录结构)：

1
2
- docker
  - gcc

tags

文章的标签，一般认为，tags并不和categories用法一致，它被用来标识文章中具有的知识领域，并用类似网络用语中的关键字来标记出来，构成另一个利于查找的维度。

由于是关键字一样的例子,你当然可以随意添加，但一定要实事求是。

文章摘要

显示在首页中和文章顶部的摘要信息，格式为：（虽然在Front-Matter添加 description也可以，不过并不推荐，文章的markdown显示效果并不好）

1
2
3
摘要
<!-- more -->
正文

（不推荐）也可以使用Front-Matter格式：

1
2
3
4
---
title: 这是标题
descriptino: 这是摘要
---

文章内图片引用

引用本地和外网资源图片，格式如下：

1
2
![](/images/example.jpg)
![](https://static.zkqiang.cn/example.jpg)

代码块

代码段请以```符号括起来，并在开头标注代码所属语言，可以根据喜好添加缩进，如：

1
2
3
4
5
# 类似这样
​```python
    def func:
        pass
```

其他扩展内容

hexo butterfly主题有很多扩展的选项，请参考这里