Markdown的使用

Markdown是什么

1. Markdown 是一种可以使用普通文本编辑器编写的纯文本格式的标记语言，通过简单的标记语法可以使普通文本内容具有一定的格式。
2. Markdown是为了实现文本到HTML转换的语言，其根本目的是为了通过实现易读易写易改的纯文本生成结构化的HTML文档。
3. Markdown中可以使用一些HTML标签元素。

Markdown用在哪里

1. 广泛用于博客平台，方便书写博客文章，例如CSDN、GitHub、简书等等。
2. 用于项目中的说明文档且以“README.MD”保存在项目目录中。

Markdown 的优缺点

1. 优点
   a. 因为是纯文本标记语言，操作简单，易读易写易改。
   b. 通过特定的语法可以方便的达到排版效果。
   c. 可以无障碍的转化为HTML文档。
2. 缺点
   a. 需要掌握特定的语法.
   b.某些平台不支持Markdown且各自平台对Markdown有不同的拓展。

Markdown 语法规则

区块元素

标题

Markdown支持两种标题的语法，类 Setext 和类 atx 形式。

1. 类Setext 标题写法:利用“=”和“-”作为底线的方式实现最高级标题和第二阶标题

	最高阶标题
	===========
	第二阶标题
	------------

2. 类 Atx 形式则是在行首插入 1 到 6 个 # ，对应到标题 1 到 6 阶，例如：

# H1
## H2
## H3
....
###### H6

也可以使用闭合形式的类atx标题，此类写法仅仅是为了美观。

# 这是第一阶标题#
###这是第二阶标题###

Markdown支持有序和无序列表

无序列表

无序列表:使用星号、加号、减号作为列表标记。

+ red
+ blue
+ yellow

- pink
- orange
- black

* white
* green

显示效果为：

• red
• blue
• yellow

• pink
• orange
• black

• white
• green

有序列表

有序列表:使用数字或者英文字母加英文句点,注意标记的数字并不会影响输出的HTML结果，其以起始序号为标准。

3. line1
4. line2
5. line3
6. line4

效果为：

1. line1
2. line2
3. line3
4. line4

上面产生的HTML标记为

<ol>
<li>line1</li>
<li>line2</li>
<li>line3</li>
<li>line4</li>
</ol>

列表内的区块引用

列表内的区块引用：区块引用需要缩进

* 列表第一项
		> 区块引用
* 列表第二项
> 区块引用

渲染效果：

• 列表第一项

  区块引用

• 列表第二项

  区块引用

列表使用中缩进的注意事项

当区块配合列表使用出现问题时，多数为缩进产生的问题，尝试修改缩进即可。

代码区块

Markdown中我们经常会需要贴一些代码，但我们不希望编辑器进行渲染，通过 <pre> 和 <code> 标签来把代码区块包起来。

	这是一个普通段落：

 	   这是一个代码区块。
 	   > my data
 	   # H1
	   ## H2
       ## H3

渲染效果：

这是一个普通段落：

   这是一个代码区块。
   > my data
   # H1
   ## H2
   ## H3

区块引用

1.普通区块引用：

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

渲染效果为：

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

也可以在整个段落的第一行最前面加上 >对整个段落引用：

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

2. 区块引用嵌套：

正文
> 第一层引用
> > 第二层引用
>
正文

渲染效果：

正文

第一层引用

第二层引用

正文

3. 区块引用可以与其他的 Markdown 语法，包括标题、列表、代码区块等综合使用：

> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码：
> 
>     return shell_exec("echo $input | $markdown_script");

渲染效果：

这是一个标题。

1. 这是第一行列表项。
2. 这是第二行列表项。

给出一些例子代码：

return shell_exec("echo $input | $markdown_script");

分割线

在Markdown中使用星号、减号、底线来建立一个分隔线，行内除空格外不能有其他东西。

* * *

***

*****

- - -

渲染效果：

---

---

---

---

区段元素：

链接

Markdown 支持两种形式的链接语法： 行内式和参考式两种形式。
行内式是直接在目标文字后加链接，格式如下：

[链接文字](URL "Tip")
For example:
[Google](http://google.com/ "点击进入Google")

显示效果：

Google

参考式：

[链接文字][链接标记]
[链接标记]：URL  "Tip"  需要换行
For example:
[Google][id] 
[id]:http://google.com/ "点击进入Google" 

显示效果：
Google网址

链接标记格式：

• 方括号（前面可以选择性地加上至多三个空格来缩进），里面输入链接文字.
• 接着一个冒号
• 接着一个以上的空格或制表符
• 接着链接的网址
• 选择性地接着 title 内容，可以用单引号、双引号或是括弧包着’

参考式链接的其他写法：

序列号标识链接：
当前市面上的搜索引擎，主要包括[百度][1] 、[谷歌][2]、[雅虎][3]等.
换行
   [1]: http://www.baidu.com
   [2]:http://www.google.com
   [3]:http://www.yahoo.com
等价于：
当前市面上的搜索引擎，主要包括[百度][] 、[谷歌][]、[雅虎][]等.
换行
   [百度]: http://www.baidu.com
   [谷歌]:http://google.com
   [雅虎]:http://search.yahoo.com/

显示效果：
当前市面上的搜索引擎，主要包括百度 、谷歌、雅虎等.

等价于：
当前市面上的搜索引擎，主要包括百度 、谷歌、雅虎等.

强调

Markdown 使用星号（*）和底线（_）作为标记强调字词的符号，被 * 或 _ 包围的字词会被转成用 标签包围，用两个 * 或 _ 包起来的话，则会被转成 ，例如：

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

***three asterisks***
___three underscores___

**_double asteristks and single underscore_**

~~delete line~~~

显示效果：
single asterisks

single underscores

double asterisks

double underscores

three asterisks
three underscores

double asteristks and single underscore

delete line~

un*frigging*believable

显示效果：

unfriggingbelievable

代码

行内代码引用:
在Markdown行内引用代码片段,可以使用引号(键盘左上角那个)将其包裹,代码会原样显示

这句话中使用了 `pritf()`代码片段.

显示效果:
这句话中使用了printf()代码片段.
代码片段显示:

使用```代码格式 代码格式可以为:java/xml/markdown等等.
代码片段
```
例如:
```java
String apose() {
String path = “”;
try {
String sourceFile = “D:\test\signnature.pdf”;
path = convertPdf2TiffApose(sourceFile);
} catch (Exception e) {
e.printStackTrace();
}
return path;
}
```

显示效果:

 String apose() {
		String path = "";
		try {
			String sourceFile = "D:\\test\\signnature.pdf";
			path = convertPdf2TiffApose(sourceFile);
		} catch (Exception e) {
			e.printStackTrace();
		}
		return path;
    }

图片

Markdown中提供了插入图片的方法,类似于链接有行内式和参考式

格式:

• 一个惊叹号 !
• 接着一个方括号，里面放上图片的替代文字
• 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上 选择性的 ‘title’ 文字。

行内式:
[imageName](/path/to/img.jpg "Optional title")
参考式:
[imageName][id]
[id]: (/path/to/img.jpg "Optional title")

其他

反斜杠:转义字符,使特殊符号按照其本身的功能使用.例如: ## h1.
<>:对于URL和email 直接显示,加不加均可.
目录自动生成:使用[TOC]或@[TOC]根据标题生成目录.
复选框:

复选框实现:
- [x] 选项一
- [ ] 选项二  
- [ ]  [选项3]

显示效果:

• 选项一
• 选项二
• [选项3]
  表格:是通过冒号的为止确定是居中还是左右对齐.

|    a    |       b       |      c     |
|:-------:|:------------- | ----------:|
|   居中  |     左对齐    |   右对齐   |
|=========|===============|============|

显示效果:

a	b	c
居中	左对齐	右对齐
=========	===============	============

对于复杂的表格markdown是无法实现的,因此需要别的工具帮助完成表格生成网站

注脚:

一个具有注脚的文本[^1]
[^1]: 注脚的解释

显示效果:
一个具有注脚的文本¹

Markdown将文本转换为 HTML。
*[HTML]:   超文本标记语言

显示效果:
Markdown将文本转换为 HTML。

总结

熟练使用Markdown可以帮助我们更好的书写博客和项目说明文档以及笔记等等,相比较与word等操作更简单.更多的功能大家慢慢探索吧.

参考文章

1.http://www.markdown.cn/#overview

---

1. 注脚的解释 ↩︎