Markdown

1 分钟阅读时长

发布时间:

discription

Markdown

目录

正文

1. Markdown是什么?

Markdown是一种轻量级标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTML格式发布。

2. 为什么要使用Markdown?

  • 它是易读(看起来舒服)、易写(语法简单)、易更改的纯文本,处处体现着极简主义的影子。
  • 兼容HTML,可以转换为HTML格式发布。
  • 跨平台使用。
  • 越来越多的网站支持Markdown。
  • AI时代下的Markdown越来越重要。

3. 基础语法

3.1 标题(1-6级标题)

使用#,可表示1-6级标题。写法如下:

# 一级标题(下方自带分割线)
## 二级标题(下方自带分割线)
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

3.2 列表(无序列表、有序列表、任务列表)

  • 无序列表:使用-(推荐)+*标记,写法如下:
- 第一项
+ 第二项
* 第三项

注意:标记后面至少有一个空格。

  • 有序列表:使用数字,并辅以. ,写法如下:
1. 第一项
2. 第二项
3. 第三项

注意:标记后面至少有一个空格。

  • 任务列表:使用- [ ] 文本- [x] 文本,写法如下:
- [ ] 待完成项
- [x] 已完成项

注意:有多个空格。

3.3 强调(标记、粗体、斜体、删除线、下划线、高亮、隐藏)

  • 标记:标记
  • 斜体:*斜体*_斜体*
  • 粗体:**粗体**__粗体__
  • 粗斜体:***粗斜体***___粗斜体___
  • 删除线:~~删除线~~
  • 下划线:<u>下划线</u>
  • 高亮:==高亮文本==
  • 隐藏:%%隐藏文本%%

3.4 分割线

最常用的分割线是使用三个或以上*,还可以使用-_,写法如下:

***
---
___

3.5 区块引用

在段落的每行使用符号>,还可使用多个嵌套引用,写法如下:

> 区块引用
>> 嵌套引用1
>>> 嵌套引用2

注意:标记>后面无需空格,但建议后面接一个空格

3.6 代码区块

方式1:在段落的每行使用四个空格或一个制表符

方式2(推荐):在代码前后各使用三个反引号```,可指定代码语言,写法如下:

```python
def main(){
   print("Hello World!")
}

3.7 公式块

  • 行内公式:使用$包围Tex公式,写法如下:
这是一个行内公式$y=x+2$。

注意:

  • $ 必须‌紧贴公式‌,前后不能有空格(否则可能无法识别)。
  • 公式内容需符合 LaTeX 语法。
  • 并非所有 Markdown 渲染器都原生支持数学公式,需确认平台是否启用 MathJax 或 KaTeX 等渲染引擎(如 Typora、Obsidian、Jupyter 支持;GitHub 默认不支持)‌
  • 行间公式:使用$$包围Tex公式,写法如下:
$$
	y=(x+2)^2
$$

3.8 链接(行内式、参考式、脚注)

行内式,写法如下

[Delluna的个人网站](https://delluna.github.io)

参考式,写法如下

[Delluna的个人网站][1][1]:https://delluna.github.io

脚注:正文显示链接,底部显示注释,写法如下

正文[^1]
[^1]:脚注

3.9 图片

使用![],写法如下:

![img_path]

3.10 表格

|表示表格纵向边界,表头和表内容用-隔开,并可用:进行对齐设置,两边都有:则表示居中,若不加:则默认左对齐。

|列标题1|列标题2|
|---|---|
|内容1|内容2|

# (左对齐|居中|右对齐)
|列标题1|列标题2|列标题3|
|:---|:---:|---:|
|内容1|内容2|内容3|

4. 其他语法

4.1 目录

[toc]回车

4.2 段落

段落的前后要有空行,所谓的空行是指没有文字内容。

段内强制换行的方式是使用两个以上空格加回车(引用中换行省略回车)

4.3 转义符 \

相当于反转义作用,使符号成为普通符号显示。如:\#\$

4.4 Tex公式

4.5 Emoji 表情

😄 :smile:
❤️ :heart:
👍 :+1:
👎 :-1:
🔥 :fire:
🔍 :mag:
🔒 :lock:
✅ :white_check_mark:

使用规范

Markdown官方教程:https://markdown.com.cn/

Markdown 书写风格指南:https://einverne.github.io/markdown-style-guide/zh.html

常见问题

  1. github上的README.md无法显示[TOC]目录? 解决方案:使用VSCode的Markdown All in One插件一键生成目录