Markdown Cookbook

Markdown - 简洁的文档语言

Markdown is a simple markup language that allows one to write documents using a text editor and transform those documents into many different formats. Among other things, it works beautifully for documenting source code since the Markdown documents can be checked in and versioned with Git or your source control system of choice.

• Mastering Markdown
• Writing on GitHub

Table Of Content

• Heading 标题
• Paragraph 段落
• List 列表
  • Unordered List 无序列表
  • Ordered List 有序列表
  • Definition List 定义列表
• Inline Code 内嵌代码
• Image 图片
• Link 链接
• Text 文本
  • Bold Text 强调文本
  • Italic Text 斜体文本
  • Deleted Text 删除文本
  • Inserted Text 插入文本
  • Combined Emphasis Text 混合文本
• Table 表格
  • Raw Table 原始表格
  • Column Alignment 列对齐
• Horizontal Rule 水平分割线
• Blockquote 引用块
• GitHub Flavored Markdown GitHub的Markdown拓展
  • User Mention 用户提醒
  • Issue Reference Issue引用
  • Task List 任务清单
  • SHA-1 References 提交Hash引用
  • Emoji 表情
• Math 数学
  • TeX Mathematical Formulae Tex数学公式
• Abbreviations 缩写
• Attribute List 属性列表
• Code Block 代码段
• Footnote 脚注
• Admonition 警示
• Meta Data 元数据
• Superscript 上标

---

Heading 标题

# Level-1 Heading
## Level-2 Heading
### Level-3 Heading

# 一级标题
## 二级标题
### 三级标题

<h1>Level-1 Heading</h1>
<h2>Level-2 Heading</h2>
<h3>Level-3 Heading</h3>

<h1>一级标题</h1>
<h2>二级标题</h2>
<h3>三级标题</h3>

Paragraph 段落

段落1

Paragraph2

<p>段落1</p>
<p>Paragraph2</p>

List 列表

Unordered List 无序列表

- Item 1
  - Item 1.1
  - Item 1.2
- Item 2

- 列表项目1
  - 列表项目1.1
  - 列表项目1.2
- 列表项目2

<ul>
  <li>Item 1</li>
  <ul>
    <li>Item 1.1</li>
    <li>Item 1.2</li>
  </ul>
  <li>Item 2</li>
</ul>

<ul>
  <li>列表项目1</li>
  <ul>
    <li>列表项目1.1</li>
    <li>列表项目1.2</li>
  </ul>
  <li>列表项目2</li>
</ul>

Ordered List 有序列表

1. Item 1
2. Item 2

3. 列表项目1
4. 列表项目2

<ol>
  <li>Item 1</li>
  <li>Item 2</li>
</ol>

<ol>
  <li>列表项目1</li>
  <li>列表项目2</li>
</ol>

Definition List 定义列表

Apple
:   Pomaceous fruit of plants of the genus Malus in
    the family Rosaceae.

Orange
:   The fruit of an evergreen tree of the genus Citrus.

<dl>
  <dt>Apple</dt>
  <dd>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</dd>

  <dt>Orange</dt>
  <dd>The fruit of an evergreen tree of the genus Citrus.</dd>
</dl>

Inline Code 内嵌代码

`code here`

<code>code here</code>
<value>code here</value>

Image 图片

![Alt Text](URL)

![替换文本](URL)

<img src="URL" alt="Alt Text"/>

<img src="URL" alt="替换文本"/>

Link 链接

[Link Text](URL)
[Link Text](URL "Tip Text")

[链接文字](URL)
[链接文字](URL "提示文字")

<a href="URL">Link Text</a>
<a href="URL" title="Tip Text">Link Text</a>

<a href="URL">链接文字</a>
<a href="URL" title="提示文字">链接文字</a>

Text 文本

Bold Text 强调文本

This text will be bold

This will also be bold

这是强调文字

这不支持中文__强调文字__

This text will be **bold**

This will also be __bold__

这是**强调文字**

这不支持中文__强调文字__

This text will be <strong>bold</strong>

This will also be <strong>bold</strong>

这是<strong>强调文字</strong>

这不支持中文<strong>强调文字</strong>

Italic Text 斜体文本

*This text will be italic*
_This will also be italic_

*次强调文字， 斜体*
_这也是次强调文字，斜体_

<em>This text will be italic</em>
<em>This will also be italic</em>

<em>次强调文字， 斜体</em>
<em>这也是次强调文字，斜体</em>

Deleted Text 删除文本

Deleted Text

删除的文字

~~Deleted Text~~

~~删除的文字~~

<del>Deleted Text</del>

<del>删除的文字</del>

Inserted Text 插入文本

++Inserted Text++

++插入的文字++

++Inserted Text++

++插入的文字++

<ins>Inserted Text</ins>

<ins>插入的文字</ins>

Combined Emphasis Text 混合文本

Combined emphasis with asterisks and underscores.

混合的文本强调和 斜体.

Combined emphasis with **asterisks and _underscores_**.

混合的文本**强调和 _斜体_**.

Combined emphasis with <strong>asterisks and <em>underscores</em></strong>.

混合的文本<strong>强调和 <em>斜体</em></strong>.

Table 表格

Raw Table 原始表格

Name	Description	Hot
Help	Display the help window.	5
Close	Closes a window	1000

| Name | Description | Hot |
| ------------- | --- | --- |
| Help | Display the help window.| 5 |
| **Close** | *Closes* a `window` | 1000 |

<!-- 1. There must be at least 3 dashes separating each header cell. -->

<!-- 2. The outer pipes (|) are optional, and you don't need to make the 
raw Markdown line up prettily. You can also use inline Markdown. -->

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Help</td>
      <td>Display the help window.</td>
    </tr>
    <tr>
      <td>Close</td>
      <td>Closes a window</td>
    </tr>
  </tbody>
</table>

Column Alignment 列对齐

Name	Description (centered)	Hot (right-aligned)
Help	Display the help window.	5
Close	Closes a window	1000

<!-- Colons can be used to align columns: right-aligned, centered, and neat -->

| Name | Description (centered) | Hot (right-aligned) |
| ------------- | :---: | ---: |
| Help | Display the help window.| 5 |
| **Close** | *Closes* a `window` | 1000 |

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Help</td>
      <td>Display the help window.</td>
    </tr>
    <tr>
      <td>Close</td>
      <td>Closes a window</td>
    </tr>
  </tbody>
</table>

Horizontal Rule 水平分割线

***

<hr/>

Blockquote 引用块

As Kanye West said:

We’re living the future so the present is our past.

As Kanye West said:

> We're living the future so
> the present is our past.

<p>As Kanye West said:</p>

<blockquote>We're living the future so
  the present is our past.</blockquote>

GitHub Flavored Markdown GitHub的Markdown拓展

Github Flavored Markdown = GFM

User Mention 用户提醒

@user

Issue Reference Issue引用

#issue

#1
<repo>#1
<user>/<repo>#1

Task List 任务清单

• @mentions, #refs, links, formatting, and tags are supported
• list syntax is required (any unordered or ordered list supported)
• this is a complete item

• this is an incomplete item

• 已完成
• 已完成
• 已完成
• 未完成

- [x] @mentions, #refs, [links](URL), **formatting**, and ~~tags~~ are supported
- [x] list syntax is required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

- [x] 已完成
- [x] 已完成
- [x] 已完成
- [ ] 未完成

SHA-1 References 提交Hash引用

Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

Emoji 表情

Refer to GitHub Emoji.

:+1: :shipit:

:+1: :shipit:

Math 数学

TeX Mathematical Formulae Tex数学公式

$-b \pm \sqrt{b^2 - 4ac} \over 2a$

$x = a_0 + \frac{1}{a_1 + \frac{1}{a_2 + \frac{1}{a_3 + a_4}}}$

$\forall x \in X, \quad \exists y \leq \epsilon$

\[-b \pm \sqrt{b^2 - 4ac} \over 2a\]

$-b \pm \sqrt{b^2 - 4ac} \over 2a$

$x = a_0 + \frac{1}{a_1 + \frac{1}{a_2 + \frac{1}{a_3 + a_4}}}$

$\forall x \in X, \quad \exists y \leq \epsilon$

$$
-b \pm \sqrt{b^2 - 4ac} \over 2a
$$

Abbreviations 缩写

The HTML specification is maintained by the W3C.

The HTML specification
is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>

Attribute List 属性列表

## Attribute List {: #head-id}

Windows lets you perform most tasks directly from the keyboard. This page lists out the default bindings (keyboard shortcuts). Windows lets you perform most tasks directly from the keyboard. This page lists out the **default**{: attrname="value" } bindings (keyboard shortcuts).
{: #someid .someclass attrname='value' }

<h2 id="head-id">Attribute List</h2>
<p attrname="value" class="someclass" id="someid">Windows lets you perform most tasks directly from the keyboard. This page lists out the default bindings (keyboard shortcuts). Windows lets you perform most tasks directly from the keyboard. This page lists out the <strong attrname="value">default</strong> bindings (keyboard shortcuts).</p>

Code Block 代码段

```python
print ('Hello world')
``` // end

<code>
print ('Hello world')
</code>

Footnote 脚注

Footnotes have a label[^label1] and the footnote's content[^label2].

[^label1]: A footnote on the label: "label1".
[^label2]: A footnote on the label: "label2".

///Footnotes Go Here///

<p>Footnotes have a label<sup id="fnref:label1"><a class="footnote-ref" href="#fn:label1" rel="footnote">1</a></sup> and the footnote's content<sup id="fnref:label2"><a class="footnote-ref" href="#fn:label2" rel="footnote">2</a></sup>.</p>

<div class="footnote">
  <hr>
  <ol>
    <li id="fn:label1">
      <p>A footnote on the label: "label1".&#160;<a class="footnote-backref" href="#fnref:label1" rev="footnote" title="Jump back to footnote 1 in the text">&#8617;</a></p>
    </li>
    <li id="fn:label2">
      <p>A footnote on the label: "label2".&#160;<a class="footnote-backref" href="#fnref:label2" rev="footnote" title="Jump back to footnote 2 in the text">&#8617;</a></p>
    </li>
  </ol>
</div>

Admonition 警示

!!! note
    You should note that the title will be automatically capitalized.

!!! danger "Don't try this at home"
    You should note that the title will be automatically capitalized.

!!! important ""
    This is a admonition box without a title.

<div class="admonition note">
  <p class="admonition-title">Note</p>
  <p>You should note that the title will be automatically capitalized.</p>
</div>

<div class="admonition danger">
  <p class="admonition-title">Don't try this at home</p>
  <p>You should note that the title will be automatically capitalized.</p>
</div>

<div class="admonition important">
<p>This is a admonition box without a title.</p>

Meta Data 元数据

Title: ABC and DCE
Summary: hello

# Heading 1

body text here

Superscript 上标

2^10^=1024

<p>2<sup>10</sup>=10</p>