写作利器-Markdown撰写规范

34次阅读

共计 1881 个字符,预计需要花费 5 分钟才能阅读完成。

本文将会介绍 Markdown 中

  • Markdown 标记的典型使用场景
  • 使用空格、空行、缩进等元素优化排版的方法
  • 常用中文标点符号规范

这些是 Markdown 写作的比较常见的排版格式指导,同时也是排版格式约定。遵守它们能使得排版更加美观,更加方便阅读,也能让你有固定的模式可依,降低写作时对于排版的心智负担。

一、Markdown 标记的典型使用

标题

  • 文章的顶层标题使用 二级标题
  • 每个小节的标题使用 三级标题
  • 小节中进一步分层组织时使用 四级标题
  • 尽量少用 五级标题 六级标题,考虑用有序列表和无序列表代替
  • 完全不用 一级标题

粗体、斜体

需要强调某处内容时使用 粗体,如:

中文全角标点符号占 一个 汉字宽度,英文半角标点占 半个 汉字宽度(亦即一个字母宽度)。

在中文排版中不使用 斜体。在英文排版中可用斜体表达强调,或表示书名、题目。

引用

以下情况使用引用标记:

  • 引述内容时(也可直接用引号替代)
  • 作示例时
  • 给出提示、警告等额外说明时

行内代码、代码块

某一行文字中嵌入简短代码时使用 行内代码,如:

打开 Linux 虚拟终端,输入 echo 'Hello World'。恭喜,你已经入门 Shell 了:)

展示多行代码时使用 代码块,也可用于 XML、JSON、配置项等。尽量在使用代码块时给出语言标识,有些 Markdown 工具会针对该语言高亮显示其中的语言元素。如:

“`java
public class Main {
&nbsp&nbsp&nbsp&nbsppublic static void main(String[] args) {
&nbsp&nbsp&nbsp&nbspSystem.out.println(“Hello World”);
&nbsp&nbsp&nbsp&nbsp}
}
“`
将显示为:

public class Main {public static void main(String[] args) {System.out.println("Hello World");
    }
}

图片

Markdown 中使用 ![图片名称](https://xx.xx/xx) 的方式来插入图片,这里的「图片名称」可以任取,但是推荐使用对图片主题具有描述性的文字。因为在一些网站或软件中,图片无法加载时会显示这个「图片名称」,这时至少还能给读者传递出一点有用信息。

二、空白符号的运用

空格

Markdown 中 半角空格 的使用很重要,一些情况下能调节文字间距使得排版更加美观。

  • 中英文混排时,英文前后各加一个空格,如:

    请坚信 Markdown 会为你带来生产力的提升。

  • 中文和阿拉伯数字混排时,数字前后各加一个空格,如:

    2008 年已经过去 11 年了!

  • 若英文或阿拉伯数字若紧邻中文全角标点,则其与标点之间 不加 空格,如:

    有了 Markdown,可以不再用 Word。

空行

正文段落之间用一个空行来分隔,可以显得段落分明、结构不拥挤,如:

Markdown 是一种标记语言。在写作时,你的所有文字都是没有样式的纯文本,在其中插入若干 Markdown 标记后,被标记的文字便有了样式。

比如,在你所写的文字中,希望某一行的最终排版呈现一级标题的样式,那就给这行文字加个一级标题的标记;某个地方有两个字需要加粗,那就给这两个字加个粗体标记。

缩进

  • 文章中每个段落的开头 不要 缩进
  • 列表中嵌套列表时,内层列表使用 4 个空格进行缩进,如:

    • 外层列表项 1
    • 外层列表项 2

      • 内部列表项 a
      • 内部列表项 b
  • 想要像上面那样在一个列表项中嵌入引用,只要在 Markdown 中将引用内容用 4 个空格缩进
  • 缩进时使用空格符,不用 Tab 符

三、中文标点符号规范

标点通用规则

中文排版时应全文使用中文全角标点,无论内容中是否包含英文词语。除非内容中包含完整的英文句子或段落,这种情况下英文内的标点使用半角标点。

引号

网络文章排版时使用直角引号——单引号「」,双引号『』。通常先使用「」,在引号嵌套时才在内层用『』。

直角引号在自媒体中比较常见,但也会有一些争议。

省略号

在中文输入法状态下,可使用 Shift + 6 输入省略号。注意是 6 个点,而非 3 个点,如:

中文里常用的标点有逗号、句号、顿号、冒号……

破折号

在中文输入法状态下,可使用 Shift + - 输入破折号。注意该符号应占两个汉字宽度,如:

破折号,标示语段中某些成分的注释、补充说明或语音、意义的变化。——《标点符号用法》

波浪线

在中文输入法状态下,可使用 Shift + `(ESC 键下方)输入波浪线。可用波浪线表示数值的区间,如:

只要 10~20 分钟你便能掌握这篇文章的要领。

注意,日期时间或地名的区间用破折号表示,如

某班上海——北京的高铁的运行时间是 10:00——16:00。


微信订阅「代码之外的自我修养」,增删改查之外来点有用且有趣的东西!

正文完
 0