MarkDown

发表于 | 分类于 | 阅读次数:

段落元素

换行

1
<br/>

标题

1
2
3
4
# 这是一级标题
## 这是二级标题
...
###### 这是六级标题

引用

1
2
> 这是外层的引用
> > 这是内层的引用

这是外层的引用

这是内层的引用

无序列表

无序列表使用 -、 + 或 * 来作为标记。

1
2
3
- 第一项
- 第二项
- 第三项

  • 第一项
  • 第二项
  • 第三项

有序列表

有序列表使用数字和紧挨着的点号表示。

1
2
3
1. 第一项
2. 第二项
3. 第三项

  1. 第一项
  2. 阿斯蒂芬
  3. 第二项
  4. 第三项

代码区域

缩进 4 个空格或者用三个’来包裹。

分割线

使用三个及以上的 *、 - 或 _来表示一个分割线。

1
***

表格

1
2
3
4
5
| Table | Col1 | Col2 |
| ----- |:----:| ----:|
| Row1  | 1-1  | 1-2  |
| Row2  | 2-1  | 2-2  |
| Row3  | 3-1  | 3-2  |
Table Col1 Col2
Row1 1-1 1-2
Row2 2-1 2-2
Row3 3-1 3-2

上面第二行中的点代表对齐方式，分别是默认（居右）、居中、居左。

行内元素

超链接

1
2
3
4
5
6
7
8
9
//方式 1
[百度](http://www.baidu.com)

//方式 2
[百度][Baidu-url]
[Baidu-url]: http://www.baidu.com

//方式 3
<http://www.baidu.com>

百度

斜体或者加粗

1
2
3
4
5
6
**这是加粗文字**
__这也是加粗文字__

//斜体
*这是斜体文字*
_这也是斜体文字_

这是加粗文字

这是斜体文字

图片

图片的插入方式跟超链接前两种插入方式类似。

1
2
3
4
5
6
//方式 1
![如果图片不能显示，就显示这段文字](图片 url)

//方式 2
![如果图片不能显示，就显示这段文字][Image-url]
[Image-url]: 图片url "这是提示文字"

我们经常需要在文章中插入一些特殊符号，而这些符号恰好是前面所讲的标识符号，可以在特殊符号前插入 \ 来直接显示符号，而不让 Markdown 来将其解释为标识符号。

拓展

其实，市场上有很多的 Markdown 解释器，它们大都能支持上面所讲的语法，但呈现出的样式往往不一。另外，不同的解释器还能支持其他自己定义的语法，比如 Github 还能支持 emoji。下面再着重介绍 Github 支持的几个 Markdown 语法。不过需要注意的是，有些语法只能在 issue 或者 pull request 上使用，这个在后面讲每个语法时会标记（约定：“通用”表示在 Github 任何地方可以使用的语法，“特殊”表示只能在 issue 或者 pull request 上使用）。

语法高亮(通用)

上面说过，有的解释器是能够显示语法高亮的，Github 就可以。

任务列表（通用）

1
2
- [ ] task one
- [x] task two
  • task one
  • task two

表格（通用）

1
2
3
4
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

SHA 引用（特殊）

每一次 commit 都会产生一个 id，用 @id 的方式可以链接到某个项目的特定的 commit。比如用 jquery/jquery@1b9575b9d14399e9426b9eacdd92b3717846c3f2 就能链接到 jquery 的一次 commit 记录上。

issue 引用（特殊）

用 #1 来引用当前 repo 的第一个 issue，
也可以用 jquery/jquery#1 引用 jquery 的第一次 issue。

@（特殊）

用 @ 来提醒目标用户。比如 @CompileYouth 可以 @ 到我。

删除符号（通用）

用连续两个 ~ 包围的词会被加上删除符。比如 This is removed。

Emoji（通用）
Github 比较有意思的是可以支持 emoji。比如 :smile: 表示笑脸等等。

插入公式

方法一：使用Google Chart的服务器

公式:
<img src="http://chart.googleapis.com/chart?cht=tx&chl= 在此插入Latex公式" style="border:none;">

例子：
<img src="http://chart.googleapis.com/chart?cht=tx&chl=\Large x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}" style="border:none;">

结果：

方法二：使用forkosh服务器

公式:
<img src="http://www.forkosh.com/mathtex.cgi? 在此处插入Latex公式">

例子：
<img src="http://www.forkosh.com/mathtex.cgi? \Large x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}">

结果：

其中方法一和方法二基本可以认为是一种方法，其基本思路是将公式传到公式解析服务器，生成图片，然后将图片插入到文档中。

方法三：使用MathJax引擎

插入：

1
2
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default">
</script>

使用tex写公式。
输入如下代码：

1
2
$$x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}$$
\\(x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}\\)

分别显示结果（行间公式）：$$x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}$$
行内公式：\(x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}\)