VS Code 使用Markdown编写文档。
MARKDOWN
Markdown是一种轻量级标记语言
所有文本都可以用上Markdown！.md
Typora广泛用于写markdown的文本软件,可以将.md导出各种.pdf,.html,.word。
Markdown基础语法：
1，强调
用于突出显示文本。
斜体
*斜体文本*或_斜体文本_
粗体
**粗体文本** 或 __粗体文本__
斜体和粗体
***斜体加粗文本*** 或 ___斜体加粗文本___
2，标题
Markdown 支持使用 # 符号来创建不同级别的标题。# 符号的数量代表了标题的级别。
一个#号，代表第一标题，其余之后同理，注意#号后有时需要空格
直到六个#号，代表第六标题
# 123这是 H1 标题
## 123这是 H2 标题
### 123这是 H3 标题
#### 123这是 H4 标题
##### 123这是 H5 标题
123这是 H1 标题
123这是 H2 标题
123这是 H3 标题
123这是 H4 标题
123这是 H5 标题
2段落
段落由一行或多行文本组成，每段之间需要有一个空行隔开。
这是一个段落。它可以包含多个句子。
这是另一个段落。
3，引用
利用>表示引用，引用通常用于展示原文。
> 这是一个引用。
这是一个引用。
嵌套引用
将两个引用嵌套起来
> 这是一个引用。
> > 这是一个嵌套引用。
这是一个引用。
这是一个嵌套引用。
4，列表
有序列表
- 要创建有序列表，请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列，但是列表应当以数字 1 起始。
1. 项目1
2. 项目2
3. 项目3
- 项目1
- 项目2
- 项目3
无序列表
- 要创建无序列表，请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。
- 项目 1
- 项目 2
- 项目 3
- 项目 1
- 项目 2
- 项目 3
嵌套列表
- 缩进一个或多个列表项可创建嵌套列表，三层嵌套之后就都是小黑方框了
- 项目 1
- 项目 2
- 子项目 1
- 子项目 2
- 项目 3
- 项目 1
- 项目 2
- 子项目 1
- 子项目 2
- 项目 3
5,代码引用
- 利用一个反引号`实现小代码区域，利用三个反引号实现以一行为最小区域的代码块,三个反引号后可以添加语言。
- 反引号具体位置
`内联代码`
`123`
代码块↓
``` C++
123
```
123
123
6，分割线 （水平线）
-
要创建分隔线，请在单独一行上使用三个或多个星号 (
***)、破折号 (---) 或下划线 (___) ，并且不能包含其他内容。用于分隔不同的部分 *** --- ___
7，删除线
~~被删除的文字~~
被删除的文字
8，链接
链接可以指向网页或者文件。
- 链接文本放在中括号内，链接地址放在后面的(括号)中，链接title可选
- 链接title是当鼠标悬停在链接上时会出现的文字，这个title是可选的，它放在圆括号中链接地址后面，跟链接地址之间以空格分隔。
- 利用
<>实现链接也可以,但是原网址会直接显示
[题目跳转](https://www.csdn.net/)
[题目跳转](https://www.csdn.net/ "分享知识的网站")
<https://www.csdn.net/>
题目跳转
题目跳转
https://www.csdn.net/
9，图片
- 要添加图像，请使用感叹号 (
!), 然后在方括号增加替代文本(可以不填)，图片链接放在圆括号里，括号里的链接后可以增加一个可选的图片标题文本。
10,表格
表格可以帮助组织数据。
- 表格利用竖线形成，反斜杠+shift实现竖线，注意竖线之间由几个空格。
| 列 1 | 列 2 | 列 3 |
| ---- | ---- | ---- |
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |
| 列 1 | 列 2 | 列 3 |
|---|---|---|
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |
表格对齐
有些Markdown编辑器支持表格中的单元格对齐方式。
| 左对齐 | 居中对齐 | 右对齐 |
| :---- | :-----: | ----: |
| 文本 | 文本 | 文本 |
| 文本 | 文本 | 文本 |
| 左对齐 | 居中对齐 | 右对齐 |
|---|---|---|
| 文本 | 文本 | 文本 |
| 文本 | 文本 | 文本 |
11，内嵌html标签
- 基本所有html标签都可以在markdown中使用，用法和html一致，效果也是。
- 不会被 Markdown 解析器特别处理。这意味着你可以使用 HTML 来添加额外的样式或功能，例如 CSS 类、id、表格样式等。
基本HTML标签
基本HTML标签
<b>加粗文本</b>
<i>斜体文本</i>
<em>强调文本</em>
<strong>强烈强调文本</strong>
<small>小字体文本</small>
加粗文本
斜体文本
强调文本
强烈强调文本
小字体文本
使用 CSS 类
<p class="highlight">这是一个带有 CSS 类的段落。</p>
这是一个带有 CSS 类的段落。
使用 CSS id
<p id="my-id">这是一个带有 CSS id 的段落。</p>
这是一个带有 CSS id 的段落。
使用 CSS 样式
<p style="color: red;">这是一个带有内联样式的段落。</p>
这是一个带有内联样式的段落。
使用表格
<table>
<tr>
<th>标题 1</th>
<th>标题 2</th>
</tr>
<tr>
<td>数据 1</td>
<td>数据 2</td>
</tr>
</table>
| 标题 1 | 标题 2 |
|---|---|
| 数据 1 | 数据 2 |
<table>
<thead>
<tr>
<td>ID</td>
<td>姓名</td>
</tr>
</thead>
使用 div
<div class="container">
<p>这是 div 内部的段落。</p>
</div>
这是 div 内部的段落。
使用 span
<span class="important">这是重要的文本。</span>
这是重要的文本。
使用图像
<img src="https://img-home.csdnimg.cn/images/20201124032511.png" alt="示例图像" title="这是示例图像">
https://img-home.csdnimg.cn/images/20201124032511.png
使用列表
<ul>
<li>列表项 1</li>
<li>列表项 2</li>
</ul>
- 列表项 1
- 列表项 2
使用注释
<!-- 这是一个 HTML 注释 -->
12 ，任务列表
- [ ] 未完成的任务
- [x] 已完成的任务
13，数学公式
Markdown 本身不支持数学公式，但许多Markdown编辑器支持使用 LaTeX 格式来插入数学公式。
行内公式
$E = mc^2$
$E = mc^2$
独立公式
$$ E = mc^2 $$
$$ E = mc^2 $$
高级数学公式
$$ \int_{-\infty}^{+\infty} e^{-x^2} dx = \sqrt{\pi} $$
14，脚注
脚注可以用来添加额外的信息或引用。
这里有一个脚注[^1]。
[^1]: 这是脚注的内容。
这里有一个脚注[^1]。
15，定义列表
定义列表用于定义术语或概念。
名词:
: 定义
: 更多解释
16，代码高亮
对于代码块，可以通过指定语言来实现语法高亮。
\```\n
```python
def hello_world():
print("Hello, world!")
````\n
def hello_world():
print("Hello, world!")
17，YAML前置元数据
Markdown 文件有时会包含YAML格式的前置元数据，用于存储文件的相关信息。
---
title: 我的文章标题
author:Jack
date: 2024-12-16
---
# 开始正文
title: 我的文章标题
author:Jack
date: 2024-12-16
开始正文
18，转义字符
在Markdown中，如果想要显示某些特殊字符而不是让它们被解析为Markdown语法的一部分，可以使用反斜杠 \ 来转义这些字符。
反斜杠（\）
\\
\
※号（*）
\*
*
下划线（_）
\_
_
大括号和方括号
\{\} \[\]
{} []
尖括号 (<>)：
\< \>
< >
竖线 (|)：
\|
|
反引号 (``)：
\`
`
井号 (#)：
\#
#
减号 (-)：
\-
-
点 (.) 和感叹号 (!)：
\. \!
. !
其他特殊字符：例如美元符号 $、百分号 % 等，通常不需要转义，除非在某些特定情况下（如数学公式）需要使用。
示例：在一个段落中显示星号 * 和下划线 _ 而不是让它们被解析为斜体
这不是 * 斜体文本 *，也不是 _ 下划线文本 _。空隔开
这不是 * 斜体文本 *，也不是 _ 下划线文本 _。
注意
- 在某些情况下，如使用星号或下划线时，只有当它们位于单词边界时才需要转义。例如，在单词中间的下划线或星号通常不需要转义。
- 当使用代码块时，通常不需要转义内部的特殊字符。
- 对于某些Markdown编辑器，你可能需要转义两次才能正确显示转义字符，例如
\\显示为\。
19，甘特图
Markdown 本身不支持直接绘制甘特图，但你可以使用Mermaid这样的工具来在Markdown文档中生成甘特图。Mermaid 是一种基于Markdown的图表生成工具，支持甘特图等多种图表。
甘特图示例：可视化展示项目中任务的开始与结束，时间，依赖关系以及完成进度，清晰了解项目整体。
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
section 现有任务
已完成 :done, des1, 2014-01-06,2014-01-08
进行中 :active, des2, 2014-01-09, 3d
计划中 : des3, after des2, 5d
这段代码将生成一个简单的甘特图。
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
section 现有任务
已完成 :done, des1, 2014-01-06,2014-01-08
进行中 :active, des2, 2014-01-09, 3d
计划中 : des3, after des2, 5d
20，UML图
Mermaid 同样支持多种UML图，包括类图、序列图、活动图等。
sequenceDiagram
张三 ->> 李四: 你好！李四, 最近怎么样?
李四-->>王五: 你最近怎么样，王五？
李四--x 张三: 我很好，谢谢!
李四-x 王五: 我很好，谢谢!
Note right of 王五: 李四想了很长时间, 文字太长了<br/>不适合放在一行.
李四-->>张三: 打量着王五...
张三->>王五: 很好... 王五, 你怎么样?
21，flow 流程图
Mermaid 支持多种图表类型，其中流程图是非常常用的一种。
lowchat
st=>start: 开始
e=>end: 结束
op=>operation: 我的操作
cond=>condition: 确认？
st->op->cond
cond(yes)->e
cond(no)->op
22，Mermaid 类图
Mermaid 支持绘制类图，可以用来表示类之间的关系。
graph LR
A[长方形] -- 链接 --> B((圆))
A --> C(圆角长方形)
B --> D{菱形}
C --> D