[关闭]
@techird 2014-11-14T03:43:52.000000Z 字数 1372 阅读 53979

GFM 格式说明

GFM Markdown 书写


GFM 是 Github 拓展的基于 Markdown 的一种纯文本的书写格式。

基础书写格式

段落

在 Markdown 中,连续的一行或多行就是一个段落。用空行来进行切段。

  1. 这是第一个段落
  2. 我跟上面是同一个段落
  3. 这是第二个段落

大纲

Markdown 中,使用 # 来定义大纲标题,有多少个 #,就表示是几级的大纲。比如:

  1. # 这是一级标题(会生成<h1>标签)
  2. 这里是段落内容
  3. ## 这里是二级标题(会生成<h2>标签)
  4. 这里是段落内容
  5. ...
  6. ###### 这里是六级标题

这种书写方式非常直观自然。

引用内容

引用部分的内容只需要在行首加上 > 就可以了。比如:

  1. > To be or not to be, that is a question.

看起来是这样的:

To be or not to be, that is a question.

强调文本

您可以使用加粗斜体来格式化文本内容。

  1. 加粗使用: **这种语法**
  2. 斜体使用: *这种语法* _这种语法_
  3. 还可以混合使用:**加粗文本中的_斜体_**

删除线

你可以使用 ~~ 包裹一段文本让它拥有删除效果

  1. 这样来~~删除一段文本~~

超链接

通过 [文本](url) 的形式来添加超链接。比如这个是一个百度脑图的超连接。

  1. [百度脑图](http://naotu.baidu.com) - 控制创意,如此简单

列表

无序列表

在行首添加 *- 可以开启列表模式,比如

  1. * 第一,...
  2. * 第二,...
  3. * 第三,...
  4. - 首先,...
  5. - 其次,...
  6. - 最后,...

有序列表

在行首添加数字,就可以开启有序列表模式,比如:

  1. 1. 打开冰箱
  2. 2. 把大象放进去
  3. 3. 关上冰箱

列表嵌套

在上一级列表的基础上加两个空格,即可嵌套列表

  1. 1. 打开冰箱
  2. 1. 用右手打开
  3. 2. 轻轻地打开
  4. 2. 把大象放进去
  5. * 不要吐槽
  6. * 大象太大
  7. * 冰箱太小
  8. * 例子很无聊
  9. 3. 关上冰箱

整体效果:

  1. 打开冰箱
    1. 用右手打开
    2. 轻轻地打开
  2. 把大象放进去
    • 不要吐槽
    • 大象太大
    • 冰箱太小
    • 例子很无聊
  3. 关上冰箱

表格

表格使用了直观的定义方式,使用 -| 分割行和列。

  1. 月份|收入|支出
  2. ----|----|---
  3. 8 |1000|500
  4. 9 |1200|600
  5. 10 |1400|650

看起来效果如下:

月份 收入 支出
8 1000 500
9 1200 600
10 1400 650

其中,航标题后的一行使用的横杆数量是不要求的,只是为了排版好看才人工对齐。比如你可以这样来定义上述表格。

  1. 月份|收入|之处
  2. -|-|-
  3. 8|1000|500
  4. 9|1200|600
  5. 10|1400|650

你还可以使用 : 指定列的对齐方式。

  1. 月份(居中对齐)|收入(右对齐)|支出(左对齐)
  2. :--------------:|-------------:|:------------
  3. 8 |1000 |500
  4. 9 |1200 |600
  5. 10 |1400 |650

看起来效果如下:

月份(居中对齐) 收入(右对齐) 支出(左对齐)
8 1000 500
9 1200 600
10 1400 650

代码

行内代码

在文本中使用 ` 包裹的内容会被识别为代码,比如

  1. 现在你可以不用 `document.getElementById()` 了,现代浏览器都把复制了 `id` 属性的元素放在了全局变量里。

渲染出来是:

现在你可以不用 document.getElementById() 了,现代浏览器都把复制了 id 属性的元素放在了全局变量里。

多行代码

使用 ``` 来包裹多行的内容成为代码。

比如:

  1. ```
  2. var a = 0;
  3. var b = 1;
  4. var c = a + b;
  5. ```
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注