MarkDown语法的使用

最新推荐文章于 2024-02-27 15:41:11 发布

小雷熊的学习时刻

最新推荐文章于 2024-02-27 15:41:11 发布

阅读量1.6k

点赞数 4

文章标签：笔记

本文链接：https://blog.csdn.net/qq_45774838/article/details/130864696

版权

MarkDown语法的使用

一、前言

MarkDown是一种轻量级的标记语言，排版语法简洁，可以让人们快速入手。并且MarkDown还还可以与HTML进行汇编，并且可以导出HTML、PDF以及本身的 .md格式的文件。
因为MarkDown语法的简洁、高效、容易入门所以MarkDown被广泛使用。
本文作者将用大白话给个位读者进行教学。
欢迎个位大佬进行指导。

二、MarkDown中标题语法

在MarkDown中的标题语法非常的简单，就是在想要成为标题的前面加上若干个 “#”。

例如：# 这是一级标题的写法

## 这是二级标题的写法

### 这是三级标题的写法

在MarkDown语法当中最多支持六级标题的出现
在MarkDown当中不仅可以使用 ”#“ 来设置标题也可以使用HTML中的标题标签进行设计

例如：<h1>这是一级标题的表示方法</h1>

<h2>这是二级标题的表示方法</h2>

在不同的编辑器中虽然支持MarkDown语法，但是可能对标记有不同的解释方法。所以读者在使用标题语法”#“时。为了考虑不同的编辑器对标记的解释。所以，请用一个空格在”#“和标题之间进行分隔。

三、MarkDown段落语法

MarkDown中的段落，是使用一行或多行的空白行进行分割。
在MarkDown中不建议使用空格(Spaces)或者制表符(Tab)进行缩进段落。
在MarkDown的官网教程中提到的是：”不要用空格(Spaces)或制表符(Tabs)缩进段落“。
读者可以使用编辑器当中的首行缩进功能对段落进行缩进。

四、MarkDown换行语法

在MarkDown中有三种换行方法
1. MarkDown原生语法，是在一行的末尾添加两个或多个空格，然后按回车键，即可创建一个换行。
2. 利用HTML中的换行标签<br>进行换行。
3. 还有一种是，CommonMark和其它几种轻量级标记语言的换行方式。就是说在行末尾添加反斜杠”\“的方式实现换行。但这种换行方式并非被所有MarkDown的编辑器所支持，所以是不推荐的。
有些轻量级标记语言支持无须在行末尾添加任何内容，只需要键入回车键即可实现换行。
所以在这里推荐读者使用前两种方式进行换行。

五、MarkDown强调语句语法

1>加粗

在MarkDown中想要对文本进行加粗时，可以在要被加粗的文本的前后各添加两个星号”*“或两个下划线”_“。
如果是想要特意加粗段落中的某个词或者是某一句时，则需要在加粗部分的两侧各添加两个星号”*“。

例如： 这里是加粗演示

加粗语法：**这里是加粗演示** 注意星号”*“和被加粗的内容之间不能存在空格

在对文本进行加粗时，建议使用星号而不是使用下划线。

2>斜体

在MarkDown中想要对文本进行倾斜时，则在要倾斜的部分前后各加一个星号或下划线。要倾斜突出文本当中的某个部分，在想要倾斜的部分前后各添加一个星号，中间不要带空格。

例如：这里是倾斜演示

倾斜语法：*这里是倾斜演示* 注意星号和被倾斜的内容之间不能存在空格

在对文本进行倾斜突出时，建议使用星号而不是使用下划线。

3>加粗&斜体同时出现

将要同时加粗和倾斜的文本两侧各添加三个星号或三个下划线。要向加粗倾斜文本的某个部分则，在被加粗倾斜的部分两侧加上三个星号，中间不要带空格

例如：这里时加粗倾斜的演示

加粗倾斜语法：***这里是加粗倾斜的演示*** 注意被加粗倾斜的部分和星号之间不要使用空格进行间隔。

为了兼容不同的MarkDown的编辑器所以在加粗倾斜的时候，建议使用星号而不是使用下划线。

六、MarkDown引用语法

在MarkDown中创建块引用时，在被引用的段落前面加一个”>“符号。

例如：我是被引用的

引用语法：>被引用的内容注意在”>“必须在段落的最开头起那面什么都不能有，空格也不行。

MarkDown中块引用可以包含多个段落。为段落之间的空白行也要添加一个”>“符号。

例如：我是多段落引用

我是第三段

引用语法：

>我是多段落引用
>
>我是第三段

MarkDown中允许块引用的嵌套，在要嵌套的段落前面添加一个”>>“符号。

例如：我是非嵌套的引用

我是嵌套的引用

引用语法：

>我是非嵌套的引用
>
>>我是嵌套的引用

MarkDown中允许块引用中包含其他MarkDown格式的元素。不过具体哪些元素可以使用需要读者进行试验。

例如：我是一个单纯的引用

我是一个带有无序列表的引用

同样我和楼上是一家的

我和例如是一家的

引用语法：

>我是一个单纯的引用
> - 我是一个带有无序列表的引用
> - 
>

七、MarkDown列表语法

1>有序列表

要创建有序列表，在每个列表项前面添加一个数字并紧跟一个英文句点。数字不必按数学顺序排序，但是列表应当以数字1起始。

例如：

我是第一个
我是第二个
我是第三个

2>无序列表

要创建无序列表，在每个列表项前面添加破折号”-“、星号”*“或加号”+“。缩进一个或多个列表项可创建嵌套列表。

例如：

我是一个无序列表
- 我是一个嵌套的无序列表
为了确保兼容性所以建议使用破折号创建无序列表，而不是使用其他的符号进行无序列表的创建。

3>在列表中嵌套其他元素

（1）如果需要在列表中添加其他元素且需要保障列表的连续性，则将要添加的元素缩进四个空格或一个制表符。

例如：

这里是第一段
这里是第二段
我是嵌套的那段
这里是第三段

- 这里是第一段
- 这里是第二段
    我是嵌套的那段
- 这里是第三段

（2）添加引用块

例如：

我是第一段
我是第二段

哈哈
我是第三段

- 我是第一段
- 我是第二段
    > 哈哈 
- 我是第三段

（3）代码块

我是演示

我是演示

<html>
  <head>
    <title>Test</title>
  </head>

我是演示

1. 我是演示
2. 我是演示
    <html>
      <head>
        <title>Test</title>
      </head>
3. 我是演示

（4）图片

我是第一段
我是第二段
我是第三段

1. 我是第一段

2. 我是第二段

   ![我是图片](图片的URL)

3. 我是第三段

（5）列表

第一段
第二段
1. 嵌套第一段
2. 嵌套第二段
第三段

1. 第一段
2. 第二段
   1. 嵌套第一段
   2. 嵌套第二段
3. 第三段

八、MarkDown代码语法

1>基础代码

将要表示为代码的单词或短语的两侧用反引号”`“包裹起来。

例如：我后面是个代码class

我后面是个代码`class`

2>转义反引号

如果在表示为代码的单词或短语中有需要被反引号引起的部分则组成代码的部分需要使用双反引号"``"引起来。

例如：我是一段代码 `我是被引起来的`

``我是一段代码 `我是被引起来的` ``

3>代码块

要创建代码块，请将代码块的每一行缩进至少四个空格或一个制表符。

4>围栏代码块

在将要成为代码块儿的前后使用三个反引号”```“或三个波浪号”~~~“括起来。
为了标注出是何种语言的代码和达到高亮的效果则在开头的反引号片旁边指定一种语言。

例如：

#include<stdio.h>
void main(){
    printf("HelloWorld");
}

九、MarkDown分隔线语法

创建分隔线的方法，是在单独一行使用三个或多个星号”***“、破折号”---“或下划线”___“，并且不能包含其他内容。

例如：

为了兼容性和美观，建议在分隔线的前后均添加空白行。

十、MarkDown链接语法

超链接语法我是超链接

语法：[我是超链接](超链接的URL)

在MarkDown语法当中可以使用尖括号将URL和email地址变成可点击的链接。

例如：<www.baidu.com>

在MarkDown中为了兼容性，尽量使用%20代替URL中的空格

十一、MarkDown图片语法

其实在MarkDown中添加图片很简单，只要在超链接的前面加上感叹号就轻松拿捏了。

例如：

在这里插入图片描述

图片语法：![图片alt](图片title)

十二、转义字符语法

要显示原本用于格式化MarkDown文档的字符，请在字符前面添加反斜杠字符”\“。

例如：我是没有被转义的 *我是被转义过的*

可做转义的字符

Character	Name
\	backslash
`	backtick (see also escaping backticks in code)
*	asterisk
_	underscore
{ }	curly braces
[ ]	brackets
( )	parentheses
#	pound sign
+	plus sign
-	minus sign (hyphen)
.	dot
!	exclamation mark
\|	pipe (see also escaping pipe in tables)

在 HTML 文件中，有两个字符需要特殊处理： < 和 & 。 < 符号用于起始标签，& 符号则用于标记 HTML 实体，如果你只是想要使用这些符号，你必须要使用实体的形式，像是 < 和 &。

& 符号其实很容易让写作网页文件的人感到困扰，如果你要打「AT&T」，你必须要写成「AT&T」，还得转换网址内的 & 符号，如果你要链接到：
```
http://images.google.com/images?num=30&q=larry+bird
```
你必须要把网址转成：
```
http://images.google.com/images?num=30&amp;q=larry+bird
```
才能放到链接标签的 href 属性里。不用说也知道这很容易忘记，这也可能是 HTML 标准检查所检查到的错误中，数量最多的。

Markdown 允许你直接使用这些符号，它帮你自动转义字符。如果你使用 & 符号的作为 HTML 实体的一部分，那么它不会被转换，而在其它情况下，它则会被转换成 &。所以你如果要在文件中插入一个著作权的符号，你可以这样写：
```
&copy;
```
Markdown 将不会对这段文字做修改，但是如果你这样写：
```
AT&T
```
Markdown 就会将它转为：
```
AT&amp;T
```
类似的状况也会发生在 < 符号上，因为 Markdown 支持行内 HTML ，如果你使用 < 符号作为 HTML 标签的分隔符，那 Markdown 也不会对它做任何转换，但是如果你是写：
```
4 < 5
```
Markdown 将会把它转换为：
```
4 &lt; 5
```
需要特别注意的是，在 Markdown 的块级元素和内联元素中， < 和 & 两个符号都会被自动转换成 HTML 实体，这项特性让你可以很容易地用 Markdown 写 HTML。（在 HTML 语法中，你要手动把所有的 < 和 & 都转换为 HTML 实体。）

引用MarkDown官网教程

十三、MarkDown表格

要添加表，请使用三个或多个连字符（---）创建每列的标题，并使用管道（|）分隔每列。您可以选择在表的任一端添加管道。
```
| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |
```
呈现的输出如下所示：

Syntax Description
Header Title
Paragraph Text
单元格宽度可以变化，如下所示。呈现的输出将看起来相同。
```
| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |
```
Tip: 使用连字符和管道创建表可能很麻烦。为了加快该过程，请尝试使用Markdown Tables Generator。使用图形界面构建表，然后将生成的Markdown格式的文本复制到文件中。

对齐

您可以通过在标题行中的连字符的左侧，右侧或两侧添加冒号（:），将列中的文本对齐到左侧，右侧或中心。
```
| 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
格式化表格中的文字

您可以在表格中设置文本格式。例如，您可以添加链接，代码（仅反引号（```）中的单词或短语，而不是代码块）和强调。

您不能添加标题，块引用，列表，水平规则，图像或HTML标签。

在表中转义管道字符

您可以使用表格的HTML字符代码（|）在表中显示竖线（|）字符。

Syntax	Description
Header	Title
Paragraph	Text

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

引用MarkDown官方教程

十四、MarkDown删除线

在要被删除部分的两侧使用两个波浪号”~~“来产生删除线的效果

例如：~~我是被删除的部分~~

删除线语法：~~我是被删除的部分~~
| Description | Test Text |
| :-------- | :---------: | ----------: |
| Header | Title | Here’s this |
| Paragraph | Text | And more |