SimpleLife带你学习,带你飞

MarkDown语法

Markdown 指南 是一份免费且开源的 Markdown 参考手册,详细讲解了
Markdown 这一简单、易用的文档格式化标记语言的用法。

官方文档
Markdown 语法的首要设计目标是尽可能易读。基于这个目标,Markdown 格式的文档能够以纯文本形式原样发布,而不会看起来像被填满了标签或格式化指令。
  1. Markdown 处处可用。人们使用它创建 网站、文档、便签、书籍、演示文稿、邮件 和 技术文档
  2. Markdown 是可移植的。可以将markdown移植到任意平台。你的格式,在其它平台依然生效
  3. Markdown 是独立于平台的。不受操作系统的限制
  4. Markdown 能适应未来的变化。及时你使用你程序不能使用了,你仍然可以使用文本编辑器读取 Markdown 格式的文本。
  5. Markdown 无处不在。众多平台支持markdown语法,如Github,博客园
创建标题:在标题前面添加井号(#)。个数代表了标题的级别
Markdown HTML 渲染效果
# Heading level 1 <h1>Heading level 1</h1>

Heading level 1

## Heading level 2 <h2>Heading level 2</h2>

Heading level 2

### Heading level 3 <h3>Heading level 3</h3>

Heading level 3

#### Heading level 4 <h4>Heading level 4</h4>

Heading level 4

##### Heading level 5 <h5>Heading level 5</h5>
Heading level 5
###### Heading level 6 <h6>Heading level 6</h6>
Heading level 6
可选语法:还可以在文本下方添加任意数量的 == 号来标识一级标题,或者 -- 号来标识二级标题。
Markdown HTML 渲染效果
Heading level 1
===============
<h1>Heading level 1</h1>

Heading level 1

Heading level 2
---------------
<h2>Heading level 2</h2>

Heading level 2

当井号(#)和标题文本之间没有空格时,各 Markdown 应用程序的处理方式是不一样的。为了兼容考虑,请在井号和标题文本之间添加一个空格。

创建段落:请使用空白行将一行或多行文本进行分隔。

MarkdownHTML渲染效果
I really like using Markdown.

I sampthink I'll use it to format all of my documents from now on.
<p>I really like using Markdown.</p>

<p>I think I'll use it to format all of my documents from now on.</p>

I really like using Markdown.

I think I'll use it to format all of my documents from now on.

换行(Line Break)用法的最佳实践

在一行的末尾添加两个或多个空格,然后按回车键(return),即可创建一个换行(line break) (<br>)。

因为很难在编辑器中直接看到空格,并且很多人在每个句子后面都会有意或无意地添加两个格
为了兼容性,请在行尾添加“结尾空格”或 HTML 的 <br>标签来实现换行。

强调字体:粗体和斜体的使用
要加粗文本,请在单词或短语的前后各添加两个星号或下划线。如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加两个星号

要用斜体显示文本,请在单词或短语前后添加一个星号或下划线。要斜体突出单词的中间部分,请在字母前后各添加一个星号,中间不要带空格。

尽量使用星号*去加粗和斜体,因为Markdown的众多应用程序处理单词中间下划线意见不一致。加粗和斜体同时使用,左右两侧添加三个星号*

> Dorothy followed her through many of the beautiful rooms in her castle.

Dorothy followed her through many of the beautiful rooms in her castle.

嵌套块引用效果:通过多个'>' 来达到效果

3

2

1

列表

你可以将多个条目组织成有序或无序列表。

1. 有序列表: 2. 无序列表
1
2
3
4
| Syntax      | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Syntax Description
Header Title
Paragraph Text

对齐

通过在标题行中的连字符(–)的左侧或右侧或两侧添加冒号(:),可以将对应列中的文本向左或向右或居中对齐。

1
2
3
4
| Syntax      | Description | Test Text     |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
Syntax Description Test Text
Header Title Here’s this
Paragraph Text And more