How to Write Documents with Markdown

Markdown

“

Markdown is a lightweight markup language created by John Gruber in 2004. It allows people to write documents in an easy-to-read and easy-to-write plain text format.
With a suitable converter, documents written in Markdown can be exported to HTML, Word, images, PDF, EPUB, and other formats.
Markdown documents usually use the extensions .md or .markdown.

Markdown Applications

Markdown can be used to write e-books with tools such as GitBook.

Many websites use Markdown for documentation or forum posts, including GitHub, Jianshu, Reddit, Diaspora, Stack Exchange, OpenStreetMap, and SourceForge.

Markdown Basics

Headings

Markdown headings have two formats.

1. Use = and - to mark first-level and second-level headings

这是H1的标题
===========

这是H2的标题
-----------

2. Use # as a marker

Use # to represent headings of levels 1-6, where a level-one heading corresponds to one # and a level-two heading corresponds to two # and so on.

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

Paragraphs

Markdown paragraphs need no special formatting; just write your text. To insert a line break within a paragraph, end the line with two or more spaces and press Enter.

A blank line separates two paragraphs.

Italics and Bold

Markdown uses *text* or _text_ for italic text, and **text** or __text__ for bold text.

Lists

Markdown supports unordered and ordered lists.

Unordered List

Unordered lists use an asterisk * or a plus + or a minus - as a list marker. Add a space after the marker, then the list item text:

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

Ordered List

Ordered lists are represented by numbers followed by a period, for example:

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

Nested Lists

To nest lists, simply add four spaces before the items in the sublist:

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

Blockquotes

Markdown blockquotes use the > marker at the beginning of a paragraph, followed by a space:

>Hi, this is xxxbrian.
>Brian's Blog
>等青春轻飘的烟雾把少年的欢乐袅袅曳去，之后，我们就能取得一切值得吸取的东西。 ——普希金

In addition, blockquotes can be nested. One > symbol is the outermost level, two > symbols are the first level of nesting, and so on:

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

Using Lists in Blockquotes

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

Using Blockquotes in Lists

+ 第一项
    > Brian's Blog
    > Hi, this is xxxbrian.
+ 第二项

Code

Wrap a function name or code fragment in backticks `, for example `code`. To display the function name printf(), write:

`printf()`函数

Code Blocks

Indent a code block with four spaces or one tab.

$(document).ready(function () {
    alert('RUNOOB');
});

The result is displayed as follows:

$(document).ready(function () {
alert('RUNOOB');
});

You can also use ``` around a code block, with an optional language identifier:

$(document).ready(function () {
    alert('RUNOOB');
});

The result is displayed as follows:

$(document).ready(function () {
    alert('RUNOOB');
});

Links

Links are used as follows:

[链接名称](链接地址)

或者

<链接地址>

For example:

这是一个链接 [Brian's Blog](https://xxxbrian.me)

This is a link Brian's Blog

Using a Link Address Directly

链接 <https://xxxbrian.me>

Link <https://xxxbrian.me>

Advanced Links

Reference-style links let you define a URL separately, usually at the end of the document:

这个链接用 1 作为网址变量 [Google][1]
这个链接用 Brian's Blog 作为网址变量 [xxxbrian][xxxbrian]

[1]: http://www.google.com/
[xxxbrian]: https://xxxbrian.me

Images

The Markdown image syntax is as follows:

![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

• Start with an exclamation mark !
• Follow it with square brackets containing the image's alt text.
• Then use parentheses containing the image URL and, optionally, a quoted 'title'.

Usage example:

![xxxbrian 图标](https://raw.githubusercontent.com/xxxbrian/xxxbrian.github.io/master/img/xxxbrian-192x192.png "xxxbrian")

Tables

To create a table in Markdown, use | to separate different cells, and use - to separate the header from other rows.

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

Table Alignment

• -: Align content and header cells to the right.
• :- Align content and header cells to the left.
• :-: Align content and header cells in the center.

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

Escaping Special Characters

Markdown uses many special symbols to represent specific meanings. If you need to display a specific symbol, you must use an escape character. Markdown uses a backslash to escape special characters:

**文本加粗** 
\*\* 正常显示星号 \*\*

Markdown supports adding a backslash before the following symbols to help insert ordinary symbols:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号