概述
Markdown 是一种轻量级的标记语言,常用于格式化文本。
支持 TeX 科学公式(基于 KaTeX)、流程图 Flowchart 和时序图 Sequence Diagram。
什么是 Markdown?
Markdown 是一种用来编写结构化文档的语法。
Markdown 使用简单的符号(如 #、*、- 等)来标记文本的格式,比如标题、列表、加粗等。
Markdown 文件的后缀通常是 .md。
Markdown 的优点:
- 语法简单,易于阅读和编写。
- 兼容性强,可以转换为 HTML、PDF 等格式。
- 广泛应用于博客、文档、笔记等场景。
Markdown 基本语法
1. 标题
使用 # 符号来表示标题,# 的数量代表标题的级别:
# 一级标题 ## 二级标题 ### 三级标题
2. 段落
段落之间需要空一行:
这是第一段。 这是第二段。
3. 强调
使用 * 或 _ 来表示斜体,使用 ** 或 __ 来表示粗体:
*斜体* _斜体_ **粗体** __粗体__
4. 列表
无序列表: 使用 -、+ 或 * 加上空格:
- 项目一 - 项目二 - 项目三
有序列表: 使用数字加点:
1. 项目一 2. 项目二 3. 项目三
5. 链接和图片
链接: [链接文字](网址)
[RUNOOB](https://www.runoob.com)
图片: 

6. 代码
行内代码: 使用 ` 包裹代码:
`print("Hello, world!")`
代码块: 使用 ``` 包裹代码,并指定语言:
MarkDown```python def hello(): print("Hello, world!")
7. 引用**
使用 > 来表示引用:
> 这是引用的内容。
8. 分割线
使用 --- 或 *** 来表示分割线:
--- Markdown 编辑器
绘制表格 Tables
| 项目 | 价格 | 数量 | | -------- | -----: | :----: | | 计算机 | $1600 | 5 | | 手机 | $12 | 12 | | 管线 | $1 | 234 | First Header | Second Header ------------- | ------------- Content Cell | Content Cell Content Cell | Content Cell | First Header | Second Header | | ------------- | ------------- | | Content Cell | Content Cell | | Content Cell | Content Cell | | Function name | Description | | ------------- | ------------------------------ | | `help()` | Display the help window. | | `destroy()` | **Destroy your computer!** | | Left-Aligned | Center Aligned | Right Aligned | | :------------ |:---------------:| -----:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | | Item | Value | | --------- | -----:| | Computer | $1600 | | Phone | $12 | | Pipe | $1 |
列表 Lists
无序列表(减号
- 列表一 - 列表二 - 列表三
无序列表(星号)
* 列表一 * 列表二 * 列表三
无序列表(加号和嵌套)
+ 列表一 + 列表二 + 列表二-1 + 列表二-2 + 列表二-3 + 列表三 * 列表一 * 列表二 * 列表三
有序列表
1. 第一行 2. 第二行 3. 第三行
GFM task list
- [x] GFM task list 1 - [x] GFM task list 2 - [ ] GFM task list 3 - [ ] GFM task list 3-1 - [ ] GFM task list 3-2 - [ ] GFM task list 3-3 - [ ] GFM task list 4 - [ ] GFM task list 4-1 - [ ] GFM task list 4-2
科学公式 TeX(KaTeX)
$$E=mc^2$$
行内的公式 $$E=mc^2$$ 行内的公式,行内的 $$E=mc^2$$公式。
$$\(\sqrt{3x-1}+(1+x)^2\)$$ $$\sin(\alpha)^{\theta}=\sum_{i=0}^{n}(x^i + \cos(f))$$
多行公式:
```math \displaystyle \left( \sum\_{k=1}^n a\_k b\_k \right)^2 \leq \left( \sum\_{k=1}^n a\_k^2 \right) \left( \sum\_{k=1}^n b\_k^2 \right) ```
```katex \displaystyle \frac{1}{ \Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{ \frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} { 1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } ```
```latex f(x) = \int_{-\infty}^\infty \hat f(\xi)\,e^{2 \pi i \xi x} \,d\xi ```
绘制流程图 Flowchart
```flow st=>start: 用户登陆 op=>operation: 登陆操作 cond=>condition: 登陆成功 Yes or No? e=>end: 进入后台 st->op->cond cond(yes)->e cond(no)->op ```
绘制序列图 Sequence Diagram
```seq Andrew->China: Says Hello Note right of China: China thinks\nabout it China-->Andrew: How are you? Andrew->>China: I am good thanks! ```