Skip to content

Markdown语法

注释

代码块写法

<div style='display: none'>Comment</div>

HTML写法

<!-- Comment -->

Hack写法

[//]: # (哈哈我是最强注释,不会在浏览器中显示。)
[^_^]: # (哈哈我是最萌注释,不会在浏览器中显示。)
[//]: <> (哈哈我是注释,不会在浏览器中显示。)
[comment]: <> (哈哈我是注释,不会在浏览器中显示。)

标题

类atx格式

# H1
## H2
### H3
#### H4
##### H5
###### H6

类Setext格式

This is an H1
=============

This is an H2
-------------

任务列表

- [ ] TODO
- [X] Checked

缩进、换行、空行、对齐

缩进

【1】 &emsp;或&#8195; //全角
【2】 &ensp;或&#8194; //半角
【3】 &nbsp;或&#160;  //半角之半角

换行

由于markdown编辑器的不同,可能在一行字后面,直接换行回车,也能实现换行.
但是在Visual Studio Code上,想要换行必须得在一行字后面空两个格子才行。

空行

在编辑的时候有多少个空行(只要这一行只有回车或者space没有其他的字符就算空行),在渲染之后,只隔着一行。

对齐

<center>行中心对齐</center>
<p align="left">行左对齐</p>
<p align="right">行右对齐</p>

斜体、粗体、删除线、下划线、背景高亮

*斜体*_斜体_
**粗体**
***加粗斜体***
~~删除线~~  
$\overline{上划线}$
$\underline{下划线}$
<mark>背景高亮</mark>

字体、字号、颜色

<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=12 face="黑体">黑体</font>
<font color=gray size=5>gray</font>
<font color=#00ffff size=3>null</font>

超链接、页内链接、自动链接、注脚

超链接

参考式

我经常去的几个网站[Google][1]、[GitHub][2]。

[1]:http://www.google.com 
[2]:http://www.github.com

行内式

[显示内容](URL)

页内链接

[显示内容](#标题)

自动链接

<http://example.com/>  
<address@example.com>

注脚

使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2]。

[^1]:Markdown是一种纯文本标记语言

[^2]:HyperText Markup Language 超文本标记语言

无序列表、有序列表

无序列表

* 无序列表项 一
+ 无序列表项 二
- 无序列表项 三

有序列表

1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三

图像

行内式写法

![Alt text](/path/to/img.jpg "Optional Title")

参考式写法

![Alt text][id]

[id]: url/to/image  "Optional title attribute"

多级引用

>一级引用
>>二级引用
>>>三级引用

目录

使用doctoc

npm i doctoc -g

doctoc demo.md

VSCode中使用Markdown-All-In-One插件

Markdown all in one: Create Table of Contents

代码块

$ python3 --version
Python 3.10.1

流程图

Markdown支持mermaid插件、flowchart.js插件流程图
VSCode不支持~

表格

不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。
- 左对齐, :-: 中心对齐,-: 右对齐

Markdown原生格式

 | Name  |  sex  |  age |
 | ----- | :---: | ---: |
 | Name1 |  男   |   90 |
 | Name2 |  男   |  100 |
 | Name3 |  女   |   90 |

Markdown简化格式

 | Name  |  sex  |  age |
 | ----- | :---: | ---: |
 | Name1 |  男   |   90 |
 | Name2 |  男   |  100 |
 | Name3 |  女   |   90 |

HTML格式

 <table>
     <tr>
         <td>ID</td>
         <td>NAME</td>
     </tr>
     <tr>
         <td>1</td>
         <td>name1</td>
     </tr>
     <tr>
         <td>2</td>
         <td>name2</td>
     </tr> 
 </table>

LaTex公式

行内公式

质能守恒方程可以用一个很简洁的方程式$E = m c^2$来表达。

整行公式

$$ 公式 $$

$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

$$ [\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+\ldots} } } }] $$

分隔线

* * *
***
*****
- - -
-----------

特殊字符

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号