Markdown语法

[jivinliu]

Markdown语法

Markdown基础

基本格式

段落

On July 2, an alien mothership entered Earth's orbit and deployed several dozen saucer-shaped "destroyer" spacecraft, each 15 miles (24 km) wide.

On July 3, the Black Knights, a squadron of Marine Corps F/A-18 Hornets, participated in an assault on a destroyer near the city of Los Angeles.

标题

# The largest heading (an <h1> tag)
## The second largest heading (an <h2> tag)
…
###### The 6th largest heading (an <h6> tag)

引用

In the words of Abraham Lincoln:

> Pardon my french

文本样式

*This text will be italic*
**This text will be bold**

列表

无序列表

* Item
* Item
* Item

- Item
- Item
- Item

有序列表

1. Item 1
2. Item 2
3. Item 3

嵌套列表

1. Item 1
  1. A corollary to the above item.
  2. Yet another point to consider.
2. Item 2
  * A corollary that does not need to be ordered.
    * This is indented four spaces, because it's two spaces further than the item above.
    * You might want to consider making a new list.
3. Item 3

代码格式化

内联格式

Here's an idea: why don't we take `SuperiorProject` and turn it into `**Reasonable**Project`.

多行格式

Check out this neat program I wrote:
```css
body {
  background: red;
}
```　

链接和图片

[link text](https://www.github.com)
![alt text](https://www.github.com/logo.png)

Github 风格语法

单词中的多个下划线

Markdown 会把所有成对的下划线（_）转换为斜体，但 GFM 不会处理单词内的那些下划线，比如这些：

• wow_great_stuff
• do_this_and_do_that_and_another_thing.

这样一来，那些采用下划线作为分隔符的代码或名字就可以正确渲染了。如果你确实要把单词中的某一部分设置为斜体，可以使用星号（*）。

链接自动识别

GFM 会自动为标准的 URL 加上链接，因此，如果你只想链接到一个 URL（而不想设置链接文字），那你直接输入这个 URL 就可以了，它将被自动转换为一个链接。（译注：Email 地址也适用于此特性。）

http://example.com

删除线

GFM 增加了删除线语法，补上了标准 Markdown 在这方面的不足。

~~Mistaken text.~~

围栏式代码块和语法高亮

标准 Markdown 会把每行前面空四格的文本块转换为代码块；GFM 同时还支持围栏式代码块。只要把你的代码块包裹在 ``` 之间就行了（如下所示），你再也不需要通过无休止的缩进来标记代码块了。请注意，虽然围栏式代码块语法并不需要在头部插入空行（缩进式代码块语法是需要的），但我们仍然建议你留出空行，因为这样可以令 Markdown 源码的可读性更好。（示例见上文代码格式化的多行格式）

表格

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |

HTML

在 README、issue 和 PR 中，你还可以使用有限的一些 HTML 语法。
关于可用的标签和属性有哪些，你可以在 github/markup 这个项目中找到一份完整的清单。

参考链接

Markdown Basics：https://help.github.com/articles/markdown-basics/
GitHub 风格的 Markdown 语法：baixing/FE-Blog#6
GitHub 上的书写方式：baixing/FE-Blog#5

[daydreamzzz]

get，thanks