0%

MarkDown 文档排版规范

MarkDown 文档排版规范

Markdown 是由 John Gruber 于 2004 年创建的一种文本标记语言,被设计用来 专注于文本写作

针对 MarkDown 文档的语法规范问题,开源平台 GitHub 发布了 Markdown GFM(GitHub Flavored Markdown) 标准规范,并修改了 MarkDown 解析器。 规范全文链接: GitHub Flavored Markdown Spec

目前针对 MarkDown 文档的简体中文排版,也已经有比较详细的规范,这篇微信公众号文章已经做了详细介绍:基于 Markdown 的中文文档排版规范,公众号内容大部分来自于 GitHub 用户 Tunghsiao Liu 的规范文档,简体中文版的文档链接:中文文案排版指北

目前中文排版规范中待完善的方面

中文文档中的英文书籍名、报刊名和文章标题(此条已有规范,但未推广普及)

根据新闻出版行业标准的编辑规范: CY/T 154-2017 标准第 10 条,应该按以下方案处理:

  • 英文书籍名、报刊名:使用英文斜体
  • 英文文章标题:使用英文正体字,并以引号标示
  • 英文书籍的副书名:使用冒号和正书名隔开
  • 英文文章的副标题:使用英文破折号和标题隔开

双引号前是否应该加空格

应该加,否则视觉上会分不清,不管是直角引号还是弯角引号都应该加。

直角引号和弯角引号的使用争议

针对繁体中文和简体中文排版(竖体和横体),同时互联网字体排版方面的问题,争议较大。知乎网站上的讨论链接:中文为什么要用直角引号?。既然争论难以统一。个人建议应该共存,同一篇文章、同一份刊物、同一本书籍,风格统一即可:

  • 直角引号:一级引号(『』)和二级引号(「」),但港台地区是反过来的
  • 弯角引号:一级引号(“ ”)和二级引号(’ ’)

使用 VS Code 编辑 MarkDow 文档

笔者同时使用 Typora 和 VS Code 这两个工具,前者是非常优秀的 MarkDow 文档编辑工具。

如果你采用后者,强烈建议安装好插件:markdownlint,此插件作者是:David Anson,GitHub 链接

在 VS Code 中按这个插件的各项规则编辑和修改 MarkDown 文档即可。

Welcome to my other publishing channels