Markdown 写作规范笔记
我写这篇笔记的目的是提供一套规范,以便在使用 Markdown 进行写作时保持一致性和可读性。遵循这些规范将有助于提高文档的清晰度和易维护性,并尽量遵守相关国家标准与行业标准。
遵守的标准如下:
- 中华人民共和国新闻出版行业标准:《中文出版物夹用英文的编辑标准》
- 草案:《夹用英文的中文文本的标点符号用法》
- 中华人民共和国国家标准:
- GB/T 15834—2011《标点符号用法》
- GB/T 15835—2011《出版物上数字用法》
- GB/T 3101—1993《有关量、单位和符号的一般原则》
- GB/T 9704—2012 《党政机关公文格式》
参考文章:
中文书写易错点 | 关于序号和小标题,别的地方不会讲的几个细节
一、字体
选择合适的字体可以显著提升文章的排版质量和阅读体验。应当根据不同的情况选择合适的字体。
(一)字体类型
这里推荐至少使用两种字体,分别应用于文章内容和标题,但最好不要超过 5 种。在同一篇文章中应保持字体选择的一致性,避免频繁更换字体。
文章内容可以采用无衬线字体(Sans-serif),无衬线字体简洁、清晰、易读,特别适合长时间阅读。适合在电子设备、网页、现代风格的文章中使用。
文章标题使用衬线字体(Serif),衬线字体优雅、传统,有助于吸引读者注意。将标题与正文内容区分开来,增加正式感和庄重感。
一些特殊用途,例如公式、代码、引用、脚注和参考文献可以使用不同的字体或样式,以区分于正文内容。列表和表格中的字体可以适当调整,以便更清晰地呈现信息。
(二)字体大小
标题和副标题应使用较大字号,吸引读者注意。正文字体应适中,确保可读性。
(三)行距和字间距
为了提高文本的可读性,行距一般比字体大。字间距(tracking)和字符间距(kerning)应调整得当,避免过于紧密或松散。
(四)颜色和对比度
确保文本颜色与背景有足够的对比度,通常黑色或深灰色文字配白色或浅色背景是最佳选择。有一点要注意,高对比度会造成很大的视觉疲劳。
高对比度会造成比高光线量更大的视觉疲劳。比如在黑暗环境下使用手机,虽然亮度低,光线较少,但由于对比度高,仍会感到刺眼。暗适应也会带来伤害。长时间看黑色界面后,突然转头看明亮环境会感到眩晕,因为眼睛和大脑需要不断调整。暗适应会增加维生素 A 的消耗,长期下来可能导致夜盲症。
人眼最放松的颜色是黄色和绿色。温暖的颜色比暗色更能让人感到舒适,因为大脑会联想到大自然。长时间看暗色或刺激性颜色会影响心情。同样的使用时间下,使用绿色柔合类型主题时的疲劳度、紧张度都明显低于使用黑色主题的。
低对比度、温暖色调的视觉环境,对眼睛健康和认知表现都更有益,尤其适合长时间使用电子屏幕的场景。但要避免使用过多颜色,这会使得文章显得杂乱。
二、空格
写作时添加空格有以下几个好处:
- 提升可读性:空格能使文字更容易阅读和理解。段落之间的空白区域可以让读者的眼睛得到休息,防止视觉疲劳。
- 组织结构:适当的空格可以帮助明确文章的结构,分隔不同的段落和部分,使文章的逻辑层次更加清晰。
- 强调重点:通过在关键句子或段落前后添加空格,可以突出重点内容,让读者更容易注意到这些部分。
- 避免误解:空格可以防止文字粘在一起,减少误读的可能性。例如,在符号和单词之间添加空格可以避免歧义。
- 视觉美感:适当的空格可以使页面布局更美观,增加文字的吸引力,提升整体阅读体验。
- 增强流畅性:空格可以自然地引导读者的眼睛,从而增强文章的流畅性,使阅读过程更加顺畅。
通过合理使用空格,可以有效提升文章的可读性和美感,使读者更愿意阅读和理解内容。
添加空格的规范:
- 中文、英文、数字之间需要增加空格。
- 行内代码前后需要增加半角空格,如果使用的是全角引号,则可省略。
- 代码块前后必须空一行。
- 数字一般使用半角字符。
- 除了度(℃)、百分号(%)、货币标志、正负数符号(+、-)之外的单位,与数字之间需要前后增加空格。如果正负数符号(+、-)不作为正负数符号使用,那么也需要增加空格。
- 全角标点与其他字符之间不加空格,因为其有足够的间距。
- “@” 标志、版权标识、项目符号等特殊符号前后需要增加空格,如果 “@” 标志用于电子邮件,则不加增加空格。
- 链接的前后可以不加空格,如果想加空格,则统一加空格。
- 中文文本中夹用英文词句时,如果英文的部分前面或后面有中文标点符号,则英文部分与中文标点之间不设空格,夹用英文段落时,英文段落内部应按英文排版规则加空格。
在中文文本中夹用英文词句时,关于是否留有空格间距的处理有几点需要注意:
- 视觉效果:首先要考虑排版的美观和阅读的舒适度。中文字符和英文字符的间距不同,直接相邻可能会显得拥挤或不协调,因此通常建议留空格以确保版面美观。
- 字体选择:不同的字体对中英文字母的混排效果有影响。某些字体设计时已经考虑到中英文混排的需求,可能不需要额外的空格。
- 字符间距:考虑中英文字符的间距是否协调。适当调整字符间距可以提升文本的整体美观度。
- 体例统一:无论是否留空格,必须保证整个文档的一致性。如果选择在英文和中文之间留空格,那么全文应保持同样的规则。
- 排版规范:遵循常见的排版规范。一般来说,中文文字和英文词句之间会留一个空格,尤其是在学术写作和正式出版物中。
三、标点符号
-
中文写作,一般使用全角标点,遇到特殊情况则特殊处理,但是要统一处理。
-
遇到英文整句、特殊名词,需要使用半角标点。
-
不要连续重复使用标点符号,例如 “!!!” 、“???”
-
使用半角斜杠「/」,前后视情况加空格。
-
引用内容或需要特别指出的内容推荐使用直角引号,表达反语、讽刺、虚假推荐使用弯引号。
-
单引号和双引号用法无区别,但别混用。
-
引号之间、书名号之间不用加顿号。
-
一行的开头不能出现点号、顿号、逗号、句号、结束引号、结束括号等。
-
一行的结尾不能出现开始引号、开始括号、开始双书名号等。
-
如果英文标点被渲染为中文标点,可通过反斜杠
\将其转译成英文标点。 -
注意连字符和减号的区别,别混用。
二、标题
标题的字数一般在 10-20 之间,一般不要超过 25 字。标题的用词要应当直接、明了,不使用冗长或复杂的词语,有创意、新意、抓人眼球,能够激发读者的兴趣。
过短的标题会带来以下坏处:
- 字数过短的标题容易与其他文章标题重复,缺乏独特性和新鲜感,搜索引擎可能会认为内容不够新颖,从而影响收录。
- 短标题往往缺乏足够的关键词信息,无法针对长尾关键词进行优化,这会导致文章在搜索引擎中的排名靠后,错失潜在流量。
- 长尾关键词是增加流量的重要途径,但短标题无法包含足够多的信息,难以嵌入这些关键词,影响 SEO 效果。
- 短标题往往缺乏吸引力,不容易激发读者的兴趣和点击欲望,在社交媒体和其他推广渠道上效果不佳。
- 对于 CMS 类网站,过短的标题会导致界面空白过多,不美观,影响用户体验和推广效果。
注意:
- 标题之间的层级关系要连续,比如一级标题下面是二级标题,二级标题下面是三级标题,不得跳级使用。
- 标题和内容之间必须空一行,来保证可读性和美观性。
五、数字序号的层级
数字序号在文章、报告、书籍或其他文档结构中起到组织内容、明确层次和提高可读性的作用。不同层级的数字序号可以帮助读者快速识别和理解文档的结构框架,以下是数字序号层级的一些作用:
- 清晰展现结构:通过不同级别的数字序号,可以清晰展示文档的章节、小节等结构层次,使内容条理化。
- 便于导航:读者可以根据序号快速定位到感兴趣的部分,尤其是在长篇文档中,序号成为一种有效的内部导航工具。
- 强调重点:较高层级的序号(如一、二、三)通常用于标示主要部分或章节,能够突出文档的主要框架和核心内容。
- 逻辑连贯:序号的有序排列有助于确保内容的逻辑连贯性,每一部分都与其上下文紧密相连,有助于思路的顺畅表达和理解。
- 方便引用:在学术写作、法律文件或技术手册中,精确的序号层级便于作者和读者引用特定部分,增强论述的准确性和权威性。
- 编辑和修订:文档结构清晰时,编辑和审阅工作也更为便捷,可以通过调整序号快速实现内容的增删和重组。
(一)人文类文章序号层级
| 第一层 | 第二层 | 第三层 | 第四层 | 第五层 | 第六层 | 第七层 |
| 一、 | (一) | 1. | (1) | ① | A. | a. |
| 二、 | (二) | 2. | (2) | ② | B. | b. |
| 三、 | (三) | 3. | (3) | ③ | C. | c. |
| (A) | (a) | |||||
| (B) | (b) | |||||
| (C) | (c) | |||||
| 第一, | ||||||
| 第二, | ||||||
| 首先, | ||||||
| 其次, |
注意:带圈的数字与内容之间留一个半角空格。
(二)理工类文章序号层级
| 第一层 | 第二层 | 第三层 | 第四层 |
| 1 | 1.1 | 1.1.1 | 1.1.1.1 |
| 2 | 1.2 | 2.2.1 | 2.2.2.1 |
| 3 | 1.3 | 3.3.1 | 3.3.3.1 |
注意:最后一个序号之后空一个全角空格再接标题。
(三)序号后标点使用规范
- 第一、第二、第三、首先、一方面、另一方面、其次等序号后面应该用逗号。也可以不用标点符号,直接连接下文。
- 第一编、第一章、第一节、壹等序号与后面的文字之间空一个空格或一个汉字的位置。
- 汉字数字作序号时,后面应该用顿号“、”。
- 不带括号的阿拉伯数字、罗马数字、拉丁字母后面应该使用实心小圆点“.”,并空一个空格。
- 带括号的序号或带圈的序号后面不加顿号、逗号之类的标点符号。
- 带圈的序号与内容之间留一个半角空格。
- 用不带括号的甲、乙、丙、丁、一、二表示顺序时,则在序号后用顿号 “、”。
- 数字序号的前后一般不再用其他项目符号。
注意:
- 谨慎使用三级以上的标题,保持层级简单,防止章节过于复杂。
- 三级标题下有并列性的内容,建议使用项目列表。
- 不应当出现孤立编号,同级的章节应至少有两个,如果只有一级章节,则将内容改为段落的形式。
六、写作风格
- 专有名词使用正确的大小写。
- 避免使用不规范的缩写。
- 使用书面语,而非网络流行语。
- 避免使用冷僻的词语和文言文的词语。
- ‘的’使用在形容词+的+名词的场合。
- ‘地’使用在副词+地+动词的场合。
- ‘得’使用在动词+得+副词的场合。
- 使用代词时,必须明确指代的内容,且保证只有一个含义。
- 名词前不要使用过多的形容词。
- 链接的文字要表明链接的文章所讲内容。
- 表格中不要使用过长的链接(URI )。
- 写作时使用主动语态,不使用被动语态。
- 为了避免黑客使用 HTML 语法入侵,尽量使用标准 Markdown 语法。
- 尽量使用现代汉语的常用表达方式,避免非正式的语言风格。
- 尽量使用肯定句表达。
- 避免使用双重否定句。
- 长句子和复杂句尽量简化。单个句子或是长句子中的分句,长度尽量保持在 20 个字以内,最好不要超过 30 个。如果超过了 30 个字,要保证语义明确。超过 40 个字的句子,可读性较差。
七、纯英文排版
-
英文句首字母大写,单词间留空格。
-
标题可只用大写字母。
-
英文点号、逗号、句号后加一个空格。
-
括号、引号前后加空格,中间内容无空格。
-
连字符 Hyphen(-)表示将两个相关单词组合成一个单词。
-
长破折号 Em dash(—)表示文章中断、转折或说明。
斜体的用法:
- 用来强调文中某个词或某句话。
- 用来标记外来语以及读者不习惯的单词。
- 文中出现的书名、剧名、美术作品的题目等等。
八、配图
(一)配图的目的
- 提升理解力:图片可以直观地展示复杂或抽象的内容,帮助读者更容易理解文章的核心信息。
- 增加吸引力:视觉元素能吸引读者的注意力,使文章更具吸引力,从而增加阅读的兴趣和参与度。
- 提供视觉休息:图片可以在大量文字之间提供一个视觉上的休息点,减轻阅读疲劳,让读者更容易持续阅读。
- 增强记忆力:图像通常比文字更容易被记住,配图可以帮助读者更好地记忆和回忆文章的内容。
- 美化排版:合理的配图可以美化文章的排版,使页面布局更为生动和美观,提高整体的视觉效果。
- 传递情感:图片能够传递文字难以表达的情感和氛围,使文章的情感表达更加丰富和生动。
- 增加分享率:配有吸引人图片的文章更容易被读者分享,从而扩大文章的传播范围。
(二)配图的要求
- 内容清晰易读比美观更重要。
- 移动平台和桌面平台都要有良好的体验。
- 使用边框的图片可以减少突兀感。
- 多张截图水平展示、竖直展示或是多张截图放在一张图片时,要有明确区隔,保持美观并只展示重要内容。
- 给图片加注文字时,最好使用指示标识(如“▲”和“▼”)引导读者。
(三)常用图片比例
| 长宽比(→↑) | 2 : 1 | 16 : 9 | 3 : 2 | 4 : 3 | 1 : 1 |
|---|---|---|---|---|---|
| 常用尺寸 | 800 * 400 | 1280 * 720、1560 * 1440 | 600 * 400 | 320 * 320 |
| 宽高比(→↑) | 1 : 2 | 9 : 16 | 2 : 3 | 3 : 4 | 1 : 1 |
|---|---|---|---|---|---|
| 常用尺寸 | 400 * 800 | 720 * 1280 | 400 * 600 | 320 * 320 |
- 1:1 比例能最大化展示图片,所以这种比例常用于电商类应用的产品主图。
- 贝壳、飓风、花和星系等自然现象都遵循斐波那契数列比例(亦称黄金比例 ‘1:1:2:3:5:8:13’)。如果没有特定的比例选择,用这个比例通常是安全且有效的。
- 很多小型相机和现代手机拍摄的照片采用 4 : 3 的比例,这是由相机的物理技术因素决定的。这种比例常用于新闻类APP,使用大量真实拍摄的照片,可以减少裁剪和加工的需求,提高工作效率。
- 人的视野范围接近 16 : 9 的长方形,这使得这种比例适合视频和广泛视野的图片展示。