Markdown

Markdown 介绍

Markdown是一种轻量级的标记语言,让你无需关注排版,专注写作。
语法简单直观,几分钟就能掌握,且跨平台通用。

官方基础语法:Markdown Guide
交互练习:Markdown Tutorial

README.md文件
README.md是使用Markdown语法写的。
它是一个项目的入门手册,里面介绍了整个项目的使用、功能等信息。
所以README.md文件写得好不好,关系到这个项目能不能更容易的被其他人了解和使用。

Markdown 语法

标题

1
2
3
4
# 一级标题
## 二级标题
### 三级标题
#### 四级标题

字体

1
2
3
4
**文字加粗**
*文字倾斜*
***文字斜体加粗***
~~文字加删除线~~

文字加粗
文字倾斜
文字斜体加粗
文字加删除线

代码

1
2
3
单行代码:`单行代码`
多行代码:```多行代码```
语言代码:```python 代码```

单行代码

1
多行代码
1
python 代码

链接

超链接

1
[链接描述](url)

图片链接

1
![图片描述](url)

列表

无序列表

1
2
3
- 无序列表
- 无序列表
- 子无序列表(缩进2空格)
  • 无序列表
  • 无序列表
    • 子无序列表

有序列表

1
2
3
1. 有序列表
2. 有序列表
1. 子有序列表(缩进3空格)
  1. 有序列表
  2. 有序列表
    1. 子有序列表

任务列表

1
2
- [ ] 任务列表
- [ ] 任务列表
  • 任务列表
  • 任务列表

分割线

1
--- 或 ***


表格

1
2
3
4
| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |
左对齐 居中对齐 右对齐
内容 内容 内容
内容 内容 内容

引用

1
> 引用

引用

数学公式

1
2
3
4
5
$ E=mc^2 $

$$
\chi^2 = \sum \frac{(O - E)^2}{E}
$$

$ E=mc^2 $

$$
\chi^2 = \sum \frac{(O - E)^2}{E}
$$

转义字符

用 \ 避免符号被解析:

1
\# 标题

# 标题

Markdown通用快捷键

功能 快捷键 效果说明
粗体 Ctrl/Cmd + B 将选中文本转为 **粗体** 格式

待补充..

Markdown编辑器

VS Code

VS Code中安装 Markdown All in One 扩展,支持自动补全、目录生成等高级功能.

MarkText

MarkText是一个开源的Markdown编辑器,支持自动保存、目录生成、自动换行等功能。
MarkText官方:https://github.com/marktext/marktext