Markdown语法详解¶
(基于mkdocs-material)
参考文档:https://iogogogo.github.io/markdown-with-mkdocs-material/
由于语法众多,因此将 大部分语法 汇总在下面表格里,便于一览。
但该表并未涵盖全部语法(如某些特殊符号),因此详情请翻看语法的具体章节
| 符号 | 用途 |
|---|---|
| # | 标题 |
| 空行 | 段落 |
| > | 引用 |
| [^sth] | 脚注 |
| !!! | 注解 |
| ??? | 折叠注解 |
| \ | 转义 |
| * | 列表 |
| + | 列表 |
| - | 列表 |
| * [x] | 任务列表 |
| + [x] | 任务列表 |
| - [x] | 任务列表 |
| --- | 分割线 |
| :shortname: | emoji |
| ` ` | 行内代码 |
| ```语言 | 代码块,带高亮 |
| TAB | 代码块 |
| #! | 代码高亮 |
| ::: | 代码高亮 |
| *sth* | 斜体 |
| _sth_ | 斜体 |
| **sth** | 粗体 |
| __sth__ | 粗体 |
| ***sth*** | 粗斜体 |
| ___sth___ | 粗斜体 |
| ^sth^ | 上标 |
| ~sth~ | 下标 |
| ^^sth^^ | 文字下划线 |
| ~~sth~~ | |
| {++sth++} | 文字下划线,绿色背景高亮 |
| {--sth--} | |
| {~~false~>true~~} | |
| {>>sth<<} | 表示注解,灰色背景高亮 |
| ==sth== | 黄色背景高亮 |
| {==sth==} | 黄色背景高亮 |
| [text](url "title") | 行内式链接 |
| [text][index],文档最后[index]: url "title" | 参考式链接 |
| 符合要求的URL | 自动链接 |
|  | 行内式图片 |
| ![alt][index],文档最后[index]: url "title" | 参考式图片 |