Markdown语法说明

Posted sandy.sun

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Markdown语法说明相关的知识,希望对你有一定的参考价值。

Markdown语法说明

1. Markdown是什么

直接贴上markdown官网说明:

2. Markdown语法

2.1 标题设置

在markdown中设置标题,有两种方式:

第一种:通过用底线的形式,即在文字下方添加“=”和“-”,他们分别表示一级标题和二级标题。

第二种:在文字前面插入1到6个#,对应到标题1到6阶(一共只有1~6级标题,1级标题字体最大)

2.2 斜体

将需要设置为斜体的文字两端使用“*”或者“_”包含起来就可以

2.3 粗体

将需要设置为粗体的文字两端使用2个“*”即“**”或者“__”包含起来,如**我是粗体1**, __我是粗体2__

2.4 列表

列表分为无序列表和有序列表两种:

无序列表:在文字开通添加(*, + ,或 -)实现无序列表。但是需要注意在(+, *, -)和文字之间需要添加空格。

有序列表:使用数字后面跟着英文句号,还需要有空格

2.5 链接

Markdown有两种链接方式,分别为行内式和参考式。

行内式:This is an [example link](http://example.com/  "Title"),如[百度一下](http://baidu.com/)

参考式: This is [an example][id] reference-style link, 接着,在文件的任意处,可以把标记的链接内容定义出来,如:

[id]: http://example.com/  "Optional Title Here"

2.6 图片

Markdown使用一种和链接很相似的语法来标记图片,同样允许:行内式和参考式。

行内式: ![Alt text](/path/to/img.jpg  “Optional title”)

参考式: ![Alt text][id], [id]是图片参考的名称,图片参考的定义方式则和链接参考意义:

[id]: url/to/image  "Optional title attribute"  

2.7 区块引用

通过文字开头添加“>”表示引用。

2.8 代码

Markdown标记代码也有两种方式:

第一种:如果要标记一小段行内代码,可以使用反引号把它包起来(`)(Tab键上方的键),如:

use the `print()` function

如果想要标记一段代码,可以使用三个反引号(```)把代码包起来,需要注意的是前面的三个反引号要有空行,后面的三个反引号后也要有空行, 如:

 

```

def add(a, b):

    return a + b

add(7, 2)

```

显示如下:

def add(a, b):
     return a + b
add(7, 2)
    

第二种:只要简单地缩进4个空格或是一个制表符就可以了,例如,下面的输入:

这是一个普通段落:
    这是一个代码区块。

 

推荐一款在线的Markdown编辑器:https://stackedit.io/ 

以上是关于Markdown语法说明的主要内容,如果未能解决你的问题,请参考以下文章

Markdown 语法说明

CSDN-markdown基本的语法说明

Markdown 语法整理

Markdown语法说明

Markdown 语法说明

VS Code配置markdown代码片段