/Markdown

Markdown Tutorial

Primary LanguageHTMLMIT LicenseMIT

Markdown Tutorial

LTS Project✅

🚧持续更新中

语法支持:

Typora

VS Code(+ "Markdown All in One")

同目录下的.html版本由Typora导出,供有需要的朋友快速查阅使用💗


通用语法

特殊语法

🚧受限于Markdown并非标准化的特性,以下语法的支持不具有普遍性,请在使用前确认目标编辑器支持该特性

快捷键

💡Windows下通过Ctrl +实现的功能在Mac OS下大多可以通过Command + 实现

参考资料

  • Markdown的历史

分级标题

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

有序列表

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

无序列表

(三种方法)

- 某项
+ 某项
* 某项

加粗

(两种方法)

**待加粗文本**
__待加粗文本__

斜体

*待斜体文本*

删除线

~~待删除文本~~

嵌套使用

插入图片

![图裂掉时的备注文本](文件路径/文件名)

示例:

![Picture_a](C:/Users/root/Pictures/Saved Pictures/a.png)

💡文件路径支持相对路径的书写形式:

同级目录下:

![Pciture_a](/a.png)

锚点

[显示文本](#需要跳转到的标题)

💡标题这里更像是CSS语法,"#" 是锚点语法中的一部分,并不是Markdown中的"分级标题"语法, 因此不需要根据标题等级打出对应数量的"#",只需要一个即可

示例:

[说明文档](#Readme)

...(中间段落)

## Readme

会被渲染为:

说明文档 /*可以看到链接标题的"(#Readme)"是不会被渲染的*/

...(中间段落)

Readme

🚧锚点并不支持含有括号的标题,即便是英文半角也不受支持,例如下标题:

标题a(含括号内容)

如果写成:

[标题a](#标题a(含括号内容)) 

>>> 标题a

明显可见识别内容将标题括号识别成了语法部分,因此即便渲染正确,却不一定能正确的链接和跳转


高亮

==待高亮文本==

>>> ==待高亮文本==

🚧高亮特性的支持并不具有普遍性,请在使用前确认编辑器的支持

上角标

需要上角标的字符^2^

💡"2"处可以是任意字符

渲染实例:

10^2^

>>> 10^2^

🚧上角标特性的支持并不具有普遍性,请在使用前确认编辑器的支持

下角标

需要上角标的字符~2~

💡"2"处可以是任意字符

渲染实例:

H~2~O

>>> H2O

🚧下角标特性的支持并不具有普遍性,请在使用前确认编辑器的支持


加粗

Ctrl + B (Windows)
Command + B (Mac OS)

斜体

Ctrl + I (Windows)
Command + I (Mac OS)

下划线

Ctrl + U (Windows)
Command + U (Mac OS)

删除线

Ctrl + S (Windows)
Command + S (Mac OS)

缩进与反缩进

缩进:

Tab

反缩进(两种方法):

1. Shift + Tab
2. Backspace