【译】Google Markdown书写风格指南

译者:nbztx
联系方式:nbztx@126.com


Markdown的出色之处主要在于能够使用纯文本书写并且得到一流的格式化输出结果,

我们想要平衡以下三个目标:

  1. 源代码具有良好的可读性和可移植性
  2. Markdown文件随时间推移、在团队之间的可维护性
  3. 语法简单且容易记忆

内容:

  1. 文档布局
  2. 字符行限制
  3. 尾随空格
  4. 标题
    1. ATX风格的标题
    2. 标题中的间隔
  5. 列表
    1. 对长列表使用“懒人编号法”
    2. 嵌套列表间距
  6. 代码
    1. 行内代码
    2. 代码块
    3. 语言声明
    4. 避免换行
    5. 列表内嵌代码块
  7. 链接
    1. 使用具有提示性的链接标题
  8. 图像
  9. 优先使用列表
  10. 优先使用Markdown语法

文档标题

一般情况下,大多数文档会采用下面几种布局:

# Document Title

Short introduction.

[TOC]

## Topic

Content.

## See also

* https://link-to-more-info
  1. # Document Title: 第一个标题应当是一个一级标题,并且应该尽可能和文件名称保持一致。第一个一级标题会被用作页面标题。

  2. author: 可选项。如果你想要说明对文档的所有权或者它是你的得意之作,就把你自己放到标题下吧,虽然版本修订记录通常就足够说明这一点了。

  3. Short introduction: 1~3句能够概括整个主题的话。想象你自己是一个完全的新手,刚刚接触你写的《Java从入门到精通》,需要了解那些你自己认为理所应当的最基本的前置知识,比如“什么是Java”、“为什么我要学习Java”。

  4. [TOC]: 用来生成目录。

  5. ## Topics: 你剩下的标题应该从二级标题开始开始使用。

  6. ## See also: 在底部为想了解更多相关知识或没有找到所需知识的用户放置各种链接。

Lorem ipsum dolor sit amet, nec eius volumus patrioque cu, nec et commodo
hendrerit, id nobis saperet fuisset ius.

*   Malorum moderatius vim eu. In vix dico persecuti. Te nam saperet percipitur
    interesset. See the [foo docs](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md).

通常在长链接前新起一行有利于可读性,并且能够最小化链接的溢出。

Lorem ipsum dolor sit amet. See the
[foo docs](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md)
for details.

尾随空格

不要使用尾随空格,用尾随的反斜杠代替。
Don't use trailing whitespace, use a trailing backslash.

虽然 CommonMark spec 判定一行末尾的两个空格等同于插入一个“<br />”标签,但很多文件系统会有提交前的尾部空格检查,很多IDE也会把尾部空格清理掉。

最好的方法是完全避免使用“<br />”的需要,Markdown用新行表示段落的标签,习惯它。

标题

ATX风格的标题

## Heading 2

含有“=”或“-”下划线的标题维护起来会很讨厌,而且和其他标题语法不兼容。用户不知道“---”的意思是H1还是H2。

Heading - do you remember what level? DO NOT DO THIS.
---------

标题中的间隔

请在“#”后加空格,并和上下文保持间隔:

...text before.

# Heading 1

Text after...

缺少间隔会让源码阅读起来有点困难:

...text before.

#Heading 1
Text after... DO NOT DO THIS.

列表

对长列表使用“懒人编号法”

Markdown非常智能,可以让生成的HTML文件正确排列你的有序列表。对于比较长的、可能会修改的列表(尤其是很长的嵌套列表),请使用“懒人编号法”:

1.  Foo.
1.  Bar.
    1.  Foofoo.
    1.  Barbar.
1.  Baz.

而对于比较短的、很少修改的有序列表,按顺序标号更好,因为这样源码读起来更加容易:

1.  Foo.
2.  Bar.
3.  Baz.

嵌套列表间距

嵌套列表时,对数字开头的列表和星号开头的列表都使用四个空格的缩进:

1.  2 spaces after a numbered list.
    4 space indent for wrapped text.
2.  2 spaces again.

*   3 spaces after a bullet.
    4 space indent for wrapped text.
    1.  2 spaces after a numbered list.
        8 space indent for the wrapped text of a nested list.
    2.  Looks nice, don't it?
*   3 spaces after a bullet.

下面这种写法也能奏效,但看起来很乱:

* One space,
with no indent for wrapped text.
     1. Irregular nesting... DO NOT DO THIS.

即使没有嵌套,使用四个空格的缩进也会让包含文本的布局显得更加连续:

*   Foo,
    wrapped.

1.  2 spaces
    and 4 space indenting.
2.  2 spaces again.

当然,如果列表规模很小、没有嵌套、只有单行,那么单个空格也足够了:

* Foo
* Bar
* Baz.

1. Foo.
2. Bar.

代码

单行代码

`反引号`定义了单行代码,并且会逐字逐句呈现所有包含的文本,用它来进行简短的代码和字段的引用:

You'll want to run `really_cool_script.sh arg`.

Pay attention to the `foo_bar_whammy` field in that table.

只在抽象意义上指明一个文件类型时,使用单行代码而不是一个具体的文件:

Be sure to update your `README.md`!

Backticks are the most common approach for "escaping" Markdown metacharacters;
in most situations where escaping would be needed, code font just makes sense
anyway.

代码块

代码超过一行时,请使用代码块:

<pre>

def Foo(self, bar):
  self.bar = bar

</pre>

语言声明

分开进行语言声明是最好的,这样无论语法高亮器还是另外的文本编辑器都不需要瞎猜。

缩进代码块有时会更清晰易读

四个空格的缩进也会被翻译成代码块,这能使源码变得更加清晰易读,缺点是无法区分语言。我们建议在写较短的片段时这样做:

You'll need to run:

    bazel run :thing -- --foo

And then:

    bazel run :another_thing -- --bar

And again:

    bazel run :yet_again -- --baz

避免换行

由于大多数命令行代码片段要被直接复制粘贴进终端,最好的方法是避免任何换行,在行尾加一个反斜杠即可:

<pre>

bazel run :target -- --flag --foo=longlonglonglonglongvalue \
--bar=anotherlonglonglonglonglonglonglonglonglonglongvalue

</pre>

列表内嵌代码块

如果你要在列表中内嵌代码块,使用缩进来确保它不会破坏列表:

*   Bullet.

    ```c++
    int foo;
    ```

*   Next bullet.

你也可以用4个空格来创建内嵌代码块,只需要从列表缩进处额外加4个空格:

*   Bullet.

        int foo;

*   Next bullet.

链接

Long links make source Markdown difficult to read and break the 80 character
wrapping。尽可能缩短你的链接

使用具有提示性的链接标题

Markdown链接语法允许你像HTML一样设置链接,但你要正确地使用它。

当读者快速浏览像“link”或“here”这样的链接标题时,他们完全得不到任何信息,这只是一种对空间的浪费。

See the syntax guide for more info: [link](syntax_guide.md).
Or, check out the style guide [here](style_guide.md).
DO NOT DO THIS.

正确的做法应该是:先按文章的意思写好句子,再回过头找出最合适的短语,把它标记成链接。

See the [syntax guide](syntax_guide.md) for more info.
Or, check out the [style guide](style_guide.md).

图像

尽可能少用图像,多使用简单的截图。这一建议的意思是纯文本能够让用户更快了解到信息的内容,而减少分心和来自作者的拖延。
尽管如此,有时候图片对于表明你的意思还是很有帮助的。

查阅 image syntax 了解更多。

优先使用列表

任何Markdown中的表格都应该尽可能小,复杂的、大型的表格在源码中读起来很困难,接下来想修改会更痛苦。

Fruit | Attribute | Notes
--- | --- | --- | ---
Apple | [Juicy](http://example.com/SomeReallyReallyReallyReallyReallyReallyReallyReallyLongQuery), Firm, Sweet | Apples keep doctors away.
Banana | [Convenient](http://example.com/SomeDifferentReallyReallyReallyReallyReallyReallyReallyReallyLongQuery), Soft, Sweet | Contrary to popular belief, most apes prefer mangoes.

DO NOT DO THIS

列表和子标题通常足够你用来呈现相同的信息,不那么紧凑,却要容易编辑得多:

## Fruits

### Apple

* [Juicy](http://SomeReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyReallyLongURL)
* Firm
* Sweet

Apples keep doctors away.

### Banana

* [Convenient](http://example.com/SomeDifferentReallyReallyReallyReallyReallyReallyReallyReallyLongQuery)
* Soft
* Sweet

Contrary to popular belief, most apes prefer mangoes.

尽管如此,有时候小型表格还是很有用的:

Transport | Favored by | Advantages
--- | --- | ---
Swallow | Coconuts | Otherwise unladen
Bicycle | Miss Gulch | Weatherproof
X-34 landspeeder | Whiny farmboys | Cheap since the X-38 came out

优先使用Markdown语法

尽可能使用标准Markdown语法,避免嵌入使用HTML。如果你无法实现你想要的效果,再好好考虑一下你是否真的需要它。因为除了大型表格,Markdown几乎已经可以满足任何需求。

任何HTML或Javascript的嵌入都会降低可读性和可移植性,这反过来会限制文档和其它工具整合的有效性,
which may either present the source as plain text or render it. See
Philosophy.

Gitiles does not render HTML.

推荐阅读更多精彩内容

  • 为什么学习Markdown 自从搭建了 Hexo 博客之后,发现还有 Markdown 这种写文章的方法,想到以后...
    lifeColder阅读 14,414评论 12 215
  • Markdown 语法 以下是 Markdown 的常用语法!在以后的笔记中将持续使用 Markdown 语法进行...
    WinSolstice阅读 528评论 0 1
  • 1. 斜体和粗体 代码: 显示效果: 这是一段斜体 这是一段粗体 这是一段加粗斜体 这是一段删除线 2. 分级标题...
    泊牧阅读 667评论 0 2
  • 当我们,看到一个新闻,听到一个节目,读到一篇文章,学习了一个课程……我们应该问问自己 这跟我有什么关系 这个问题,...
    荞米阅读 26评论 0 0
  • 明仕河边思明世幸福桥头悟幸福 幸福桥头的农大妈过着的,才是真正属于田园的恬淡无忧无欲无求的幸福生活。 早晨在田园里...
    梅紫酱阅读 247评论 4 1