Markdown使用指南

2023-03-27
【本文共418字母,2890字】

Markdown使用#、+、*等符号来标记,是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。 Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。 Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。 Markdown 编写的文档后缀为 .md, .markdown。 Markdown 能被使用来撰写电子书,如:Gitbook。 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。


1、标题

Markdown 标题支持两种形式:

1、用#标记

在 标题开头 加上1~6个#,依次代表一级标题、二级标题….六级标题

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

效果:

一级标题

二级标题

三级标题

四级标题
五级标题
六级标题

2、用=和-标记

在 标题底下 加上任意个=代表一级标题,-代表二级标题

2、列表

2.1 有序列表和无序列表

Markdown支持有序列表和无序列表,无序列表使用星号(*)、加号(+)或者减号(-)作为标记:

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

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

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

显示效果:

  • 第一项
  • 第二项
  • 第三项

  • 第一项
  • 第二项
  • 第三项

  • 第一项
  • 第二项
  • 第三项

有序列表直接在文字有加上1. 2. 3. 来表示,符号和文字之间加上一个空格字符,如:

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

  4. 第一项
  5. 第二项
  6. 第三项

2.2列表嵌套

列表嵌套只需在子列表的选项前添加四个空格即可:

  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

显示效果:

  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

3、Markdown段落

Markdown的段落没有特殊的格式,直接编写文字就好,段落的换行号是使用两个以上的空格加回车。

3.1 字体

Markdown 可以使用以下几种字体:

用1个星号*或底线_表示斜体
用2个星号*或底线_表示粗体
用3个星号*或底线_表示粗斜体

语法格式:

*斜体文字*

_斜体文字_

**粗体文字**

__粗体文字__

***粗斜体文字***

___粗斜体文字___

显示效果:

斜体文字

斜体文字

粗体文字

粗体文字

粗斜体文字

粗斜体文字

3.2 分隔线

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

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

显示效果:






3.3 删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线~~即可。

语法格式:

baidu.com
sina.com
~~tencent.com~~

显示效果如下:

baidu.com sina.com tencent.com

3.4 下划线

下划线可以通过HTML的标签来实现

<u>带下划线文本</u>

显示效果如下:

带下划线文本

3.5 脚注

脚注是对文本的补充说明。

Markdown脚注的格式如下:

[^要注明的文本]:

显示效果:

[^要注明的文本]:

四、Markdown区块

Markdown区块引用是在段落开头使用>符号,然后后面紧跟一个空格符号:

> 区块引用
> Markdown教程
> 学的不仅是技术更是梦想

显示效果如下:

区块引用 Markdown教程 学的不仅是技术更是梦想

另外区块是可以嵌套的,一个>符号是最外层,两个符号是第一层嵌套,以此类推:

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

最外层

第一层嵌套

第二层嵌套

五、Markdown链接

链接使用方法如下:

[链接名称](链接地址)
或者
<链接地址> 【注意】:圆括号内的内容是隐藏的,尖括号内的内容是会显示的

例如:

这是一个链接 [新浪新闻](https://news.sina.com.cn/)

<https://news.sina.com.cn/>

显示效果如下:

这是一个链接 新浪新闻

https://news.sina.com.cn/

5.1 高级链接

链接也可以用变量来代替,文档末尾附带变量地址:
这个链接用1作为网址变量[baidu][1]
这个链接用markdown作为网址变量[Markdown][markdown]
然后文档的结尾为变量赋值(网址)

[1]: http://www.baidu.com
[markdown]: http://www.markdown.com

显示效果如下:

链接也可以用变量来代替,文档末尾附带变量地址: 这个链接用1作为网址变量baidu 这个链接用markdown作为网址变量Markdown 然后文档的结尾为变量赋值(网址)

六、Markdown图片

Markdown图片语法格式为:

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

    开头一个感叹号!
    接着一个方括号,里面放上图片的代替文字
    接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的'title'属性文字。

实例如下:

![logo](/images/2023-3-27-markdown/logo.png)

logo

也可以像网址那样对图片使用变量:

这个图片链接用image1作为网址变量
然后在文档的结尾为变量赋值(网址)
![logo][image1]

[image1]: /images/2023-3-27-markdown/logo.png

显示效果如下:

这个图片链接用1作为网址变量 然后在文档的结尾为变量赋值(网址)

logo

* Markdown 没有办法指定图片的高度与宽度,如果需要的话,可以使用普通的标签。

<img src="/images/2023-3-27-markdown/logo.png"  width=40%>

显示效果:

<img src=”/images/2023-3-27-markdown/logo.png” width=40%>


参考地址:

菜鸟教程:https://www.runoob.com/markdown/md-tutorial.html

知乎详解:https://www.runoob.com/markdown/md-tutorial.html