Markdown 入门


关于Markdown

Markdown是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文本

背景

因为写博文需经常用到Markdown语法,于是产生了对Markdown语法进行系统整理的想法。

Markdown的优势

  • 简单标记符完成排版,所写即所见,让你专注于文字而不是排版
  • 纯文本,所以兼容性极强,可以用所有文本编辑器打开
  • 格式转换方便,Markdown文本可以轻松转换为 html、pdf等
  • Markdown 的标记语法有极好的可读性

基本语法

1. 斜体和粗体

代码:

*斜体*或_斜体_
**粗体**
***加粗斜体***
~~删除线~~

显示效果:

  • 斜体斜体
  • 粗体
  • 加粗斜体
  • 删除线

2. 分级标题

第一种写法:

这是一个一级标题
============================
这是一个二级标题
--------------------------------------------------

第二种写法:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

3. 超链接

Markdown 支持两种形式的链接语法: 行内式和参考式两种形式,行内式一般使用较多。

3.1. 行内式

语法说明:

[]里写链接文字,()里写链接地址, ()中的”“中可以为链接指定title属性,title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字。[链接文字](链接地址 “链接标题”)’这样的形式。链接地址与链接标题前有一个空格。

代码:

欢迎来到[CSDN](http://csdn.net)
欢迎来到[CSDN](http://csdn.net "CSDN")
这里写代码片

显示效果:

3.2. 参考式

参考式超链接一般用在学术论文上面,或者另一种情况,如果某一个链接在文章中多处使用,那么使用引用 的方式创建链接将非常好,它可以让你对链接进行统一的管理。

语法说明:

参考式链接分为两部分,文中的写法 [链接文字][链接标记],在文本的任意位置添加[链接标记]:链接地址 “链接标题”,链接地址与链接标题前有一个空格。

如果链接文字本身可以做为链接标记,你也可以写成[链接文字][] 
[链接文字]:链接地址的形式,见代码的最后一行。

代码:

我经常去的几个网站[Baidu][1]、[CSDN][2]以及[自己的博客][3]
[Leanote 笔记][2]是一个不错的[网站][]。
[1]:http://www.baidu.com "Google"
[2]:http://www.csdn.net"Leanote"
[3]:http://http://blog.csdn.net/adminpd"梵居闹市"
[网站]:http://http://blog.csdn.net/adminpd

显示效果:

3.3. 自动链接

语法说明:

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用<>包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

代码:

<http://example.com/>
<address@example.com>

显示效果:

4. 锚点

网页中,锚点其实就是页内超链接,也就是链接本文档内部的某些元素,实现当前页面中的跳转。比如我这里写下一个锚点,点击回到目录,就能跳转到目录。 在目录中点击这一节,就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的。

注意:

1. Markdown Extra 只支持在标题后插入锚点,其它地方无效。 
2. Leanote 编辑器右侧显示效果区域暂时不支持锚点跳转,所以点来点去发现没有跳转不必惊慌,但是你发布成笔记或博文后是支持跳转的。

语法描述:

在你准备跳转到的指定标题后插入锚点{#标记},然后在文档的其它地方写上连接到锚点的链接。

代码:

## 0. 目录{#index}
跳转到[目录](#index)

显示效果:

5. 列表

5.1. 无序列表

使用 *,+,- 表示无序列表。

代码:

- 无序列表项 一
- 无序列表项 二
- 无序列表项 三

显示效果:

  • 无序列表项 一

  • 无序列表项 二

  • 无序列表项 三

5.2. 有序列表

有序列表则使用数字接着一个英文句点。

代码:

1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三

显示效果:

  1. 有序列表项 一
  2. 有序列表项 二
  3. 有序列表项 三

5.3. 定义型列表

语法说明:

定义型列表由名词和解释组成。一行写上定义,紧跟一行写上解释。解释的写法:紧跟一个缩进(Tab)

代码:

Markdown
:    轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)
代码块 2
:   这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)
        代码块(左侧有八个不可见的空格)

显示效果:

Markdown
: 轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)
代码块 2
这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)
代码块(左侧有八个不可见的空格)

代码块(左侧有八个不可见的空格)

5.4. 列表缩进

语法说明:

列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。

要让列表看起来更漂亮,你可以把内容用固定的缩进整理好(显示效果与代码一致):

轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。 
那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 
软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 
寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 
但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥! 
悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

但是如果你懒,那也行:

代码:

*   轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。
那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 
软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草! 
*   那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 
寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 
但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥! 
悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

显示效果:

轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。
那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。
软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。
寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。
但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥!
悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

5.5. 包含段落的列表

语法说明:

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符(显示效果与代码一致):

轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。 
那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 
软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!

那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 
寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 
但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥!

悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

如果你每行都有缩进,看起来会看好很多,当然,再次地,如果你很懒惰,Markdown 也允许:

代码:

*   轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。
那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 
软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
*     那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 
寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 
但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥! 
*    悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

显示效果:

  • 轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。
    那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。
    软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
  • 那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。
    寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。
    但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥!
  • 悄悄的我走了, 正如我悄悄的来; 我挥一挥衣袖, 不带走一片云彩。

5.6. 包含引用的列表

语法说明:

如果要在列表项目内放进引用,那 > 就需要缩进:

代码:

*   阅读的方法:
    > 打开书本。
    > 打开电灯。

显示效果:

  • 阅读的方法:

    打开书本。
    打开电灯。

5.7. 包含代码区块的引用

语法说明:

如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符:
  • 一列表项包含一个列表区块:

    <代码写在这>

5.8. 一个特殊情况

在特殊情况下,项目列表很可能会不小心产生,像是下面这样的写法:

1986. What a great season.

会显示成:

  1. What a great season.

换句话说,也就是在行首出现数字-句点-空白,要避免这样的状况,你可以在句点前面加上反斜杠:

1986\. What a great season.

会显示成:

1986. What a great season.

6. 引用

语法说明:

引用需要在被引用的文本前加上>符号。

代码:

> 这是一个有两段文字的引用,
> 无意义的占行文字1.
> 无意义的占行文字2.
> 
> 无意义的占行文字3.
> 无意义的占行文字4.

显示效果:

这是一个有两段文字的引用,
无意义的占行文字1.
无意义的占行文字2.

无意义的占行文字3.
无意义的占行文字4.

Markdown 也允许你偷懒只在整个段落的第一行最前面加上 > :

代码:

> 这是一个有两段文字的引用,
无意义的占行文字1.
无意义的占行文字2.
> 无意义的占行文字3.
无意义的占行文字4.

显示效果:

这是一个有两段文字的引用,
无意义的占行文字1.
无意义的占行文字2.
无意义的占行文字3.
无意义的占行文字4.

6.1. 引用的多层嵌套

区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 > :

代码:

>>> 请问 Markdwon 怎么用? - A
>> 自己看教程! - B
> 教程在哪? - A

显示效果:

请问 Markdwon 怎么用? - A
自己看教程! - B
教程在哪? - A

6.2. 引用其它要素

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

代码:

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

显示效果:

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

给出一些例子代码:

return shell_exec(“echo $input | $markdown_script”);

7. 插入图像

图片的创建方式与超链接相似,而且和超链接一样也有两种写法,行内式和参考式写法。

语法中图片Alt的意思是如果图片因为某些原因不能显示,就用定义的图片Alt文字来代替图片。 图片Title则和链接中的Title一样,表示鼠标悬停与图片上时出现的文字。 Alt 和 Title 都不是必须的,可以省略,但建议写上。

7.1. 行内式

语法说明:

![图片Alt](图片地址 “图片Title”)

代码:

markdown 语法: 
![markdown 语法](https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1503249365272&di=4365c9b433a96044bb53b28c674ffdf3&imgtype=0&src=http%3A%2F%2Fimage.lxway.com%2Fupload%2F9%2Fc0%2F9c0c87edd315f32f61efce70cb403cc7.jpg "markdown 语法")

显示效果:

markdown 语法:
markdown 语法

7.2. 参考式

语法说明:

在文档要插入图片的地方写![图片Alt][标记]

在文档的最后写上[标记]:图片地址 “Title”

代码:

markdown 语法: 
![markdown 语法][markdown ]
[markdown ]:https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1503249365272&di=4365c9b433a96044bb53b28c674ffdf3&imgtype=0&src=http%3A%2F%2Fimage.lxway.com%2Fupload%2F9%2Fc0%2F9c0c87edd315f32f61efce70cb403cc7.jpg "markdown 语法"

显示效果:
markdown 语法:
![markdown 语法][markdown ]
[markdown ]:https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1503249365272&di=4365c9b433a96044bb53b28c674ffdf3&imgtype=0&src=http%3A%2F%2Fimage.lxway.com%2Fupload%2F9%2Fc0%2F9c0c87edd315f32f61efce70cb403cc7.jpg “markdown 语法”

8. 内容目录

在段落中填写 [TOC] 以显示全文内容的目录结构。

效果参见最上方的目录

9. 注脚

语法说明:

在需要添加注脚的文字后加上脚注名字[^注脚名字],称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。

​ 注意:经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。

代码:

使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。

[^1]:Markdown是一种纯文本标记语言

[^2]:HyperText Markup Language 超文本标记语言

[^Le]:开源笔记平台,支持Markdown和笔记直接发为博文

显示效果:

使用 Markdown^1可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote^Le 编辑器进行书写。

[^2]:HyperText Markup Language 超文本标记语言

注:脚注自动被搬运到最后面,请到文章末尾查看,并且脚注后方的链接可以直接跳转回到加注的地方。

10. LaTeX 公式

10.1. $ 表示行内公式:

代码:

质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。

显示效果:

质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。

10.2 $ 表示整行公式:

代码:

$$\sum_{i=1}^n a_i=0$$
$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$
$$\sum^{j-1}_{k=0}{\widehat{\gamma}_{kj} z_k}$$

显示效果:
$$\sum_{i=1}^n a_i=0$$
$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$
$$\sum^{j-1}{k=0}{\widehat{\gamma}{kj} z_k}$$

11. 流程图

代码:

​```mermaid
flowchat
st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes)->e
cond(no)->op
显示效果:

​```mermaid
flowchat
st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes)->e
cond(no)->op

12 .表格

语法说明:

不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。

代码:

简单方式写表格:

学号|姓名|分数
-|-|-
小明|男|75
小红|女|79
小陆|男|92

原生方式写表格:

|学号|姓名|分数|
|-|-|-|
|小明|男|75|
|小红|女|79|
|小陆|男|92|

为表格第二列指定方向:

产品|价格
-|-:
Leanote 高级账号|60元/年
Leanote 超级账号|120元/年

显示效果:

简单方式写表格:
学号 姓名 分数
小明 75
小红 79
小陆 92
原生方式写表格:
学号 姓名 分数
小明 75
小红 79
小陆 92
为表格第二列指定方向:
产品 价格
Leanote 高级账号 60元/年
Leanote 超级账号 120元/年
#### 13. 分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

代码:

* * *
***
*****
- - -
---------------------------------------

显示效果都一样:

14. 代码

对于程序员来说这个功能是必不可少的,插入程序代码的方式有两种,一种是利用缩进(Tab), 另一种是利用”`”符号(一般在ESC键下方)包裹代码。

语法说明:

插入行内代码,即插入一个单词或者一句代码的情况,使用`code`这样的形式插入。

插入多行代码,可以使用缩进或者“` code “`,具体看示例。

注意: 缩进式插入前方必须有空行

####8.1. 行内式

代码:

C语言里的函数 `scanf()` 怎么使用?

显示效果:

C语言里的函数 scanf() 怎么使用?

####8.2. 缩进式多行代码

缩进 4 个空格或是 1 个制表符

一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。

代码:

    #include <stdio.h>
    int main(void)
    {
        printf("Hello world\n");
    }

显示效果:

    #include <stdio.h>
    int main(void)
    {
        printf("Hello world\n");
    }

####8.3. 用六个`包裹多行代码

代码:

#include <stdio.h>
int main(void)
{
printf(“Hello world\n”);
}

显示效果:

#include <stdio.h>
int main(void)
{
    printf("Hello world\n");
}

####8.4. HTML 原始码

在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,剩下的 Markdown 都会帮你处理,例如:

代码:

第一个例子:

<div class="footer">
   © 2004 Foo Corporation
</div>

第二个例子:

<table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>

显示效果:

第一个例子:
第二个例子:
值班人员 星期一 星期二 星期三
李强 张明 王平

文章作者: Anosh
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 Anosh !
 上一篇
面向对象的原则 面向对象的原则
对于面向对象语言而言,有“六原则,一法则”去遵循: 六原则 单一原则:一个类只应该做它该做的事情,做到高聚合,低耦合 开闭原则:开放拓展,关闭修改。既尽量从原有系统派生出新类,而避免直接对原系统的修改 依赖倒置原则:面向接口编程 里氏替换原
2020-07-26
下一篇 
Java 面向对象 Java 面向对象
一、面向对象(OOP) 本质是以类的方式组织代码,以对象的方式组织数据。 面向过程Vs面向对象 区别 面向过程:事物比较简单,可以用线性思维去解决(第一步做什么,接下来做什么…) 面向对象:事物比较复杂,使用简单的线性思维无法解决
2020-07-18
  目录