SEAEPOCH WRITING STANDARDS

〇、引言

2023 年 08 月 20 日，我花费近乎一整天时间重构了 Matery 主题的源代码。其中，最大的更新莫过于文章显示样式的更新和修正。而我所作这一切的目的便是为了更加快速、准确、舒服地分享我的文章！

就目前情况来看，本主题和原主题除了风格相近之外，几乎已经做出了很大的改变（这里不仅指风格及样式上的变化，还指对 Matery 主题的源码做了大量重构和新增）。所以，这里我更愿意将本主题称之为 SEAEPOCH 主题。

当然，本篇的目的还主要是对博客的行文规范做出一定的约束，从而达到更好的显示效果，并达到规避不期的 BUG 和 EXCEPTION 的目的。同时，一篇文章的显示方式也会对读者的理解产生巨大的影响。下面对比两种极端的阅读样式：

可见，一篇优秀的博文不仅需要内容，更需要舒适的样式。这也是我这两天做这么多努力的最直接的原因！

一、博文书写规范

1.1 标题规范

首先，一篇文章最重要的就是标题文字了！一个好的标题不仅应该直接明了，更应该赏心悦目！

1. 字数规范一个好的标题应当用最少的字数显示最多的信息。同时，当标题文字过长时往往让人无法一眼看懂你要讲什么，那么他就是失去意义的标题。所以，你的标题不应该超过 30 个英文字符宽度（针对 SEAEPOCH 主题 | 单个中文字符占 2 个英文字符宽度）。对于其他主题，你应当根据自己的文章标题的字体和具体情况而定，这个往往因人而异，但是宗旨都应该是：简洁大方、言简意赅！
2. 编号规范有些博客的标题显示本来就不明显，但是还没有合理的编号习惯，导致在阅读其文章时往往容易分不清楚几级标题进而影响理解（特别是有的人乱标题名起，真的非常影响阅读体验）。所以，规范标题编号是很有必要的，他将直接影响读者的阅读舒适度！下面给出示例：

标题——编号规范
# 一、一级标题
## 1.1、二级标题
### 1.1.1、三级标题
#### Ⅰ）

同时，标题的层级也不应该过多（详细请见下文）。
当层级过多时，就会导致标题的编号冗长，从而影响阅读体验。
所以，标题的层级应该限制在 3 级之内。

3. 样式规范你的一级标题和二级标题应当具有一条独立的分割线，以分隔正文内容。并且，一级标题的分割线应当比二级标题的分割线略粗，这样可以进一步区分这两种等级的标题。当然，这不是必须的，可以视情况而定（但是本人非常推荐这么做）。
4. 其他规范对于五级标题和六级标题，应该有其特殊用处。
   • 五级标题：用于对正文内容的注意、注释、补充等补充内容的标题。
   • 六级标题：保留使用。

补充

注意，虽然“参考文献”、“参考文章”等类似的标题通常也享有一级标题的等级，但是其不应该参与到编号之中，应该独立地放在文章的末尾。

1.2 正文规范

如果标题像是一个人的头，那么内容就是一个人的身体。理论就是双脚，言辞即为胸肚。所以，正文也是非常重要的一部分，而将这一部分展示好也是非常关键的。

本人认为，一个好的正文应该干净清楚、重点突出。

所谓的干净清楚是指，正文中不应该出现过多的粗体、斜体、单行代码、高亮标记和下划线等有特殊样式结构的内容穿插在内。否则，内容会像是长了皮癣的皮肤一样难看。故而，内容应当保持干净，给人清爽的感觉，这样才能使人清楚的了解到你想要表达的内容主体。

而重点突出是指，正文中也当适量穿插粗体、斜体、单行代码、高亮标记和下划线等具有强调样式结构的内容用于突出重点的句子、关键字等内容。当然，本人认为突出关键词比突出句子往往能够起到更好的表达效果，所以粗体、单行代码、高亮标记等应该更多的被给予关键词。具体请看下文介绍：

1. 段落规范在博文中往往与一般写文章不太一样，往往是没有明确的段落之分的。一般在文章中，段落是指开头空两格的一段内容。而在博文中，往往会因为种种原因并没有明确的开头空两格的习惯（文章渲染规则导致打那两个空格往往很麻烦 | 对于文字特别少的操作文往往会有局部显得很突兀）。所以，博文里面的段落往往指单独换一行（有的 MD 语法中表现为相隔空一行）的区域文字。而这却容易造成文章内容的“不紧凑”，使得文章看起来很散漫。

   所以，本人建议：应该像写文章类似的去写博文。我们应该适当使内容聚合，又应该适当使其分开（否则博文内容聚在一起会显得臃肿）。就像人一样，如果太瘦就会显得弱不禁风；如果太胖就会显得臃肿笨重，只有舒适的 BMI 才让人看着舒心。而划分的规则就是按照你想要表达的观点或行为去划分，具体含义就是：一个行为或一个观点即分一段。

   当然，每个人理解不一样，划分出来的段落也是有区别的。这很正常，毕竟一千个人总有一千个哈姆雷特嘛！但是，宗旨还是不变的：为了更加清晰、舒适。

2. 粗体规范粗体往往用于着重突出，一般会有显著的视觉效果。但是，滥用也会导致文章混乱不堪。所以，粗体应当仅用于关键词或关键词组的突出强调。具体来说什么样的关键词或关键词组应当被突出呢？本人认为一般的重点行为、核心名词等都是需要突出的关键词或关键词组。

   当然，同段内容中的关键词或关键词组仅突出一次就可以了。如果前文已经突出过该关键词或关键词组，那么后文（这里指在同一段内容中）非必要便不需要再次突出。最后，具体实施还是需要依据博主自己的主观进行设置。

3. 斜体规范在博文中，斜体应该被更多的用于（甚至应该仅用于）表示人名、书名、名言警句等正文中特殊的引用。因为这些内容往往有着一些特殊的含义，但是其又具有一些特殊的意义，需要用一种特殊的方式进行突出。而斜体对于此场景，那是太合适不过了！

4. 下划线规范在博文中，下划线应该被用于强调一整个句子。即使我们已经用粗体强调了合适的关键词或关键词组，但是不免还是有些地方我们希望能突出一下。而这些地方往往很难抽线出关键词或关键词组，或者这一句话本身就是有被强调的需要。那么，使用下划线进行强调他们是个很合适的方法！

5. 删除线规范删除线一般用的很少，但是也会有用到的时候。例如，旧内容不再被需要、被遗弃或者被替换等情况，就需要用下划线将其标志出来。这样不仅老读者不会因为新内容的突然出现和旧内容的突然消失而迷惑，新读者也能在看到新内容后对旧内容有一定的了解。

6. 单行代码规范单行代码的使用比较简单粗暴，你只需要对所有嵌入正文段落内容的代码进行包裹就行了。这样的好处也就是可以防止浏览器自带的翻译软件对代码进行翻译，要知道这往往是没有意义的。

   虽然，这在一定程度上会影响代码嵌入较多的段落内容的阅读感受，但是你也需要这么做。因为，怎么让这些嵌入的代码看起来舒服，那是单行代码样式设置的问题，不应该用书写规范进行约束。

7. 高亮标记规范高亮标记是一个极为特殊的存在，他应该用于一些公式标注、小标题强调以及其他需要强调但是待强调内容又与『粗体强调、下划线强调』等略有不同的内容。

8. 中英文混合规范这是最重要的规范之一。因为，2 个英文符号的宽度约等于 1 个中文字符（在等宽字体中，这点尤为明显）。所以，当中英文字符混合在一起时，就会显得混乱。为此，还诞生了一个知名的 Github 仓库——盘古之白 PanguJs（有兴趣可以自行了解，反正我一直手打）。据说，这个名字的由来就是：在中英文字符间加上一个空格的行为，就像盘古劈开天地一样，劈开了中英文字符混在一起的那种混沌感。具体规则如下：

   • 中文文字与英文文字、英文符号之间应该有一个空格用于分隔二者，从而让博文显示更加舒心。
   • 中文符号与英文文字之间不需要空格，不然会相隔很远。
   • 在图片标题编号时是例外，应当保持编号外的“盘古之白”，而标题编号内不应该在中英文文字间穿插空格。

注意：

无论那种强调方式，都不应该强调以符号开头或结尾的内容！

1.3 表格规范

博文中应该尽可能少使用表格，需要使用表格的地方更多的应该被制成图片并取代。因为，博文中的表格很可能在小屏幕设备上显示得不那么令人愉快，而图片则不会有显示问题。所以，能不用表格的地方应该尽可能的不使用表格。

但是，适当的使用表格也会给你的博客增添一份特色。于是，我总结了一下，以下情况都满足时往往可以使用表格：

• 表格的列数尽可能的少，应该在 1~2 列之间（具体也要看你表格每列内容的量，但是超过 3 列后实在不推荐再使用表格）。
• 表格每列内容在无分段排列的情况下不应该超过 3 行。

1.4 图片规范

1. 体积规范这里是指用尽可能小体积的图片来展示我们需要的图片效果。因为当图片体积过大时，加载图片往往就需要花费一定的时间。虽然很多博客现在都做了图片懒加载处理，但是总是会有图片尺寸和懒图尺寸不一致的时候吧！当二者尺寸不一致的时候，就会出现图片突然变大而把内容撑下去的现象，或多或少还是会影响体验（特别是在网速不好的情况下）。

   一般建议所有图片体积应该控制在 1MB 以内，没有特别高的清晰度要求的大图片可以限制在 700KB 以下（一般为 200KB~500KB 之间），一般图片应该被控制在 100KB~200KB 及左右。表情包、头像等小型图片应该被控制在 100KB 以内（一般在 20KB~80KB 之间）。

2. 样式规范每一张图片应该被给予一个标题，并用于给图片编号。这样做是合理的，因为你可以通过编号让读者迅速找到对应的图片。同时，图片的标题也可以进一步与标题形成结构上的呼应，从而增强文章的结构体系。但是，这不是必须的！每个人可以根据自己的实际情况来选择。

   不过不得不提醒的是，即使没有标题也应该给图片设置 ALT 属性值，这对你的博客网站有利！当然，你完全可以通过 ALT 标签来设置标题内容，然后通过 CSS 样式和 JS 脚本进行显示该标题。

3. 标题规范图片的标题应该被适当的编号（<img src="" alt="">）。这个编号应该依据二级标题进行编号（因为一级标题往往是总领，需要二级标题引导具体的正文内容，而用三级标题开始编号则会导致编号太长）。当然，当找不到二级标题时便可依据一级标题进行编号。如果连一级标题也没有，亦或者一级标题为“〇”号，那么可以不用进行编号。下面给出具体的实例：

![图片标题]()

# 〇、一级标题

![图片标题]()

# 一、一级标题

![图1.1 图片标题]()

## 1.1 二级标题

![图1.1.1 图片标题]()

### 1.1.1 三级标题

![图1.1.2 图片标题]()

#### Ⅰ）

![图1.1.3 图片标题]()

1.5 列表规范

1. 样式规范
   • 有序列表：对于有序列表，应该适当增大编号序号字体，并且使其加粗进行强调（亦或者使用不同颜色进行强调）。同时，应该缩小编号符号与列表内容间的距离。最后，编号序号应该使用小写的阿拉伯数字
   • 无序列表：对于无序列表，应该使用 ● 之类的字符进行编号，从而保持编号字符与正文的相对位置。
   • 共同：对于列表，应该适当保持两列表项内容之间的距离。
2. 应用规范对于列表的使用，应该具有严格的规范（但这也不是必须的，但是我们任然推荐这么做）。无序列表应该仅用于具有并列含义、无顺序相关性的列表内容；有序列表则应该应用于具有步骤、时间等有着先后关系的列表内容。
3. 书写规范
   • 当列表项出现多段内容时，最后一段内容应该与列表下一项之间空一行，并且每段内容之间也应该空一行（告诉渲染器需要用 p 标签进行包裹）。
   • 当列表项需要插入其他特殊结构（例如：代码块、图片等）时，应该使其为正文结构中的一部分，不应该使其称为列表结构中的一部分。因为列表会带着这些特殊结构一起缩进，不仅影响美观，开可能导致一些未知的 BUG 或 EXCEPTION 。

1.6 超链接规范

一般超链接分为两大类，一类是正文内容中掺夹的超链接，通常作为正文的一部分，不用另起一段；另一类是单独起一行超链接。

1. 正文超链接一般来说没有太大问题，注意文字内容最好不要以符号开头或结尾即可。另外，超链接不应该直接给链接地址，应该使用文本内容作为显示。
2. 独行超链接可以适当使用引用进行包裹，以达到强调作用。

1.7 代码块规范

代码块用于显示较多的代码，一般是具有某个独立功能的代码段。

1. 样式规范在样式上主要有以下几点需要注意：
   • 代码语言类型必须填写。常见可填写的语言类型有：TEXT（用于普通文本）、MD/MARKDOWN、C、CPP、CSHARP（用于C#）、HTML、CSS、JAVASCRIPT、JAVA、PYTHON、BASH、SHELL……（具体怎么写还要取决于自己的 MD 渲染器所支持的语言类型名称的写法！）
   • 代码语言类型名称应该全部大写。全部大写可以保持一致，维持美观。驼峰式的名称虽然更加易于读取理解，但是会有影响美观的小瑕疵。因为这不是让读者理解你写的代码所属类型的地方，你的代码类型应该体现在你的前后文之中。并且，语言类型名称一般很简短，所以驼峰式真的没必要。
   • 标题可以视情况填写。当给代码块取一个 MD 分级标题不太合适，亦或者影响美观时，就可以使用代码块自带标题进行一定的说明。需要注意的是，这个标题不应该过长。
   • 只显示水平方向滚动条。水平方向超出代码块显示区域的应该展示水平方向的滚动条，而垂直方向不应该显示滚动条。如果代码块过长，可以使用类似于“显示全部”的按钮进行控制。
   • 当代码块被设置圆角时，滚动条应该规避被圆角切割。并且水平滚动条应该从代码块行号区域最右的末端开始，这个可以通过设置 ::-webkit-scrollbar-track 的 margin-left 和 margin-right 来实现。
2. 书写规范代码块在书写时，具体的代码内容应该与 ```Language Type Name 和 ``` 保持一行留白，从而使得文章 MD 原文更加清晰、整洁。

1.8 引用块规范

引用块无特殊要求。一般本人并不会将其用作引用，更多的会用来做一个特殊的强调，例如：文章的前提申明、部分内容的前提申明等。不过一般来说引用块嵌套不应该超过 2 层，最多也不应该超过 4 层。

1.9 高亮标记规范

高亮标记一般可以用于以下场景，不过都应该是简短的内容：

• 列表小标题。这个一般用的最多，也是最合适的使用方式。
• 数学公式。当然，这个也不是必须的，需要看自己的需要进行标记。
• 特殊强调。当上文所列举的所有强调方式都不够用的时候，就可以使用该方式进行强调。

二、博文其他规范

暂无

三、结语

本文介绍了博文书写规范，包括标题规范和正文规范，提供了一种规范化的写作方式，使读者能够更轻松地阅读理解博文内容。

文章中，在标题规范部分，指出了标题字数规范，应尽量简洁明了，并给出了编号规范和样式规范的示例。正文规范部分强调了干净清晰和重点突出的原则。段落规范建议适当地划分段落，使内容更加聚合而不散漫。在使用样式结构上，粗体用于关键词或关键词组的突出，斜体用于表示人名、书名、名言警句等引用，下划线用于强调整个句子，删除线用于标记不再需要或被替换的旧内容，单行代码用于包裹嵌入的代码，高亮标记用于公式标注、小标题强调等特殊内容。同时，对中英文混合的书写提出了规范，建议在中英文字符之间添加空格分隔，但在中文符号与英文文字之间不需要空格。当然，还有很多规范这里也不一一列举了。

总而言之，遵循博文书写规范可以提高博文的可读性和专业性，使读者更好地理解和吸收所表达的内容。

这篇文章既是对我自己博客博文的行文规范进行约束，也是希望能帮助到其他用心做博客的博主提炼出自己的行文规范。

2023.08.22