博客写作规范

  新年新气象，在开发过程中，越发经常的遇到以前解决过的问题，却忘记了具体的解决方案。为了避免这种情况的再次发生，我决定今年开始使用 Hexo 记录我的学习过程和问题解决方案。通过写博客，帮助自己整理思路，也能方便日后查找参考。下面是一些我总结的 Hexo 使用技巧以及博客写作的建议，留作自己日后查阅。本文只会从网络提取一些对我个人比较重要的写作规范，完整资料请从参考文章中获取。

文章结构

标题

• 少用三级，不用四级
• 标题下应有描述，避免多层标题重叠
• 不跨级使用、不孤立编号、不与上级同名

正文

• 句号：中文句尾用全角；句号应写在括号外
• 逗号：避免“一逗到底”，即全部停顿都使用逗号
• 括号：名称统一，如 {} 大括号、 [] 方括号、 <> 尖括号、 （） 圆括号
• 文本：中英文之间留一个空格（与标点符号不留空格）；区别增加/降低（了/到）
• 句子：尽量用肯定句；避免双重否定句；中文书名号，英文双引号

Markdown

• 引用：标记文章/图片来源
• 代码：单行用 code 进行包裹，多行用代码块进行包裹
• 链接：明确链接标题，如果需要显示链接来源，可以用 | 或 - 进行分隔

Hexo使用

文章草稿

由于我配置的发布后的文件名为 日期+标题 ，会影响相对路径，所以不适用 Hexo 默认的草稿模板。

如果需要，直接把文章手动移动到 _drafts 文件夹下即可不在页面中显示，发布时直接从文件夹中移出即可。

文章摘要

尽量给文章写摘要/前言，明确文章的内容，建议使用 进行首行缩进。

如无：默认提取内容（不含代码块）的前200个字符。

如有：在该部分后添加<!--more-->标签，让 Hexo 正确识别摘要的内容。

文章跳转

如果需要跳转到同站点的其它博客，使用{% post_link 文章原标题（必填） 文章显示标题（选填） %}来插入连接。

图片保存

使用hexo new 文章标题或hexo n 文章标题来创建文章，会同时创建对应的文章图片文件夹。

如果文章中没有图片信息，建议删除该文件夹方便后续对文章的整理。

文章配置

在文章的 Front-matter 中可以完成文章的配置，常用的项目有：

日期：date: 2000-01-01 12:00:00，需和文件名的日期保持一致

置顶：sticky: 大于0的正整数，此数值代表置顶文章的优先级，默认为0，建议不超过100

隐藏：hide: true

标签：用于标记主要语言，一般为大写全称（如：HTML、CSS、JavaScript、TypeScript、Go、Nginx）

# 单标签
tag: 标签

# 多标签
tag:
- 标签1
- 标签2

分类：用于标记文章分类，一般为二级分类（规定的大分类有：前端开发、后端开发、后端运维）

# 单分类
categories: 分类
categories: [分类, 子分类]

# 多分类
categories:
- 分类1
- [分类2, 子分类]

说明：一般使用单标签+单分类，如果文章没有标签或者分类，建议保留初始化时的 yml 信息，方便后续添加。

样式修改

如果需要对样式进行修改，可以直接修改主题的 npm 包。

使用 patch-package 执行 npx patch-package hexo-theme-icarus 对修改进行保存。

后期计划

Cloudflare托管

Hexo博客搜索引擎优化

参考文章

如何写好技术文档 | 程序员李林

如何用Hexo优雅的书写文章 | CSDN博客

开发者如何编写优雅的技术文档 | Frank’s 技术世界