Markdown语法

Markdown语法

由于md文件同一个效果可能有不同写法,我只记录下我喜欢的用法,方便后续查询使用。

一、标题

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

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

二、段落样式

2.1 换行

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车
而在换行基础上加一个回车或者直接两次回车会导致空出一行。

2.2 字体

Markdown 可以使用*或者_切换字体
示例如下:

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

2.3 分隔线

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

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

2.4 删除线

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

~~BAIDU.COM~~

效果:BAIDU.COM

2.5 下划线

下划线可以通过HTML的<u>标签来实现:

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

效果:带下划线文本

三、列表

Markdown 支持有序列表和无序列表。

3.1 无序列表

无序列表使用星号(*)加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

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

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

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

效果如下:

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

3.2 有序列表

有序列表使用数字并加上 . 号来表示,如:

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

效果如下:

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

3.3 列表嵌套

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

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

效果如下:

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

四、区块

4.1 区块使用

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

> 区块引用

效果如下:

Tips:在vscode里面使用markdown的时候,可以拆分编辑器,一边预览,一边写作。

4.2 区块嵌套

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

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

效果如下:

最外层

第一层嵌套

第二层嵌套

4.3 区块与列表

区块中使用列表
区块中使用列表实例如下:

> 区块中使用列表
> 1. 第一项
> + 第一项

效果如下:

区块中使用列表

  1. 第一项
  • 第一项

五、代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

`printf()` 函数

效果如下:
printf() 函数

你也可以用```包裹一段代码,并指定一种语言(也可以不指定)
例如指定为javascript:
```javascript
代码块
```
效果如下:

$(document).ready(function () {
    alert('RUNOOB');
});

六、链接

6.1 直接链接

<链接地址>

效果:
https://hualog.dns.navy

6.2 别名链接

[链接名称](链接地址)

效果:花落阁

6.3 高级链接

如果一个链接被多次使用,我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:

这个链接用 hualog 作为网址变量 [花落阁][hualog]
然后在文档的结尾为变量赋值(网址)
[hualog]: https://hualog.dns.navy

效果:
这个链接用 hualog 作为网址变量 花落阁

七、图片

Markdown 图片语法格式如下:

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

效果如下:
元宝 图标

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

<img src="/img/cat.jpg" width="50%">

八、表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

8.1 初始表格

语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

效果如下:

表头 表头
单元格 单元格
单元格 单元格

8.2 表格对齐方式

我们可以设置表格的对齐方式:

-:设置内容和标题栏居右对齐。
:-设置内容和标题栏居左对齐。
:-:设置内容和标题栏居中对齐。
实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
|   x   |   x   |   x    |
|   x   |   x   |   x    |

效果:

左对齐 右对齐 居中对齐
x x x
x x x

九、高级技巧

9.1 支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

效果:
使用 Ctrl+Alt+Del 重启电脑

9.2 转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

**文本加粗** 
\*\* 正常显示星号 \*\*

效果:
文本加粗
** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

9.3 公式

Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。

KaTeX 拥有比 MathJax 更快的性能,但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。

$...$ 或者 \(...\) 中的数学表达式将会在行内显示。
$$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。

例如:

$f(x) = sin(x) + cos(x)$
$$f(x) = sin(x) + cos(x)$$

行内:
$f(x) = sin(x) + cos(x)$
块内:
$$f(x) = sin(x) + cos(x)$$


转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论,也可以邮件至 1430797759@qq.com

文章标题:Markdown语法

字数:1.7k

本文作者:花落阁

发布时间:2022-08-22, 11:24:12

最后更新:2024-04-26, 14:43:27

原始链接:https://hualog.dns.navy/2022/08/22/Markdown%E8%AF%AD%E6%B3%95/

版权声明: "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。