Markdown教程

前言

工欲善其事必先利其器

书写博客内容或项目的README文档是一个繁琐的过程一个好的工具能让简化这个过程而Markdown绝对是最好的工具之一我将用这一篇博客带你入门Markdown的语法

Markdown简单介绍

引自Wikipedia

Markdown是一种轻量级标记语言创始人为约翰·格鲁伯它允许人们使用易读易写的纯文本格式编写文档然后转换成有效的XHTML或者HTML文档这种语言吸收了很多在电子邮件中已有的纯文本标记的特性

由于Markdown的轻量化易读易写特性并且对于图片图表数学式都有支持目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息GitHubRedditDiscordDiasporaStack ExchangeOpenStreetMap SourceForge简书甚至还能被用来撰写电子书

Markdown可用于在纯文本文档中添加格式化元素让使用者更加专注于文字内容能轻松在码字的同时做出美观大方的排版不用受到格式上的桎梏

Markdown工作原理

Markdown编辑器应用程序通过Markdown处理器将markdown格式的文本转换为html格式从而在Web上显示

Markdown 格式的文件转换为 HTML 或可打印的文档的步骤如下

  1. 使用文本编辑器或 Markdown 专用的应用程序创建 Markdown 文件该文件应带有 .md 或 .markdown 扩展名
  2. 在 Markdown 应用程序中打开 Markdown 文件
  3. 使用 Markdown 应用程序将 Markdown 文件转换为 HTML 文档
  4. 在 web 浏览器中查看 HTML 文件或使用 Markdown 应用程序将其转换为其他文件格式例如 PDF

Markdown基础教程

个人比较推荐直接看Markdown官方教程本文仅是Markdown一个粗略的教程


Markdown官方教程
元素 Markdown语法 说明
标题 # H1</br>## H2</br>### H3 要创建标题请在单词或短语前面添加井号(#) #数量代表了标题的级别
段落 空白行隔开即可 要创建段落请使用空白行将一行或多行文本进行分隔不要用空格spaces或制表符 tabs缩进段落
换行 空格+回车即可 在一行的末尾添加两个或多个空格然后按回车键,即可换行
粗体 ** 内容 ** 要加粗文本请在单词或短语的前后各添加两个星号**
斜体 * 内容 * 要用斜体显示文本请在单词或短语前后添加一个星号(*)
删除线 ~~ 要删除内容 ~~ 在单词前后使用两个波浪号~~
块引用 > 引用内容 要创建块引用请在段落前添加一个 > 符号
多段落引用 >段落1
>
>段落2
段落之间的空白行添加一个> 符号
嵌套块引用 >内容
>>嵌套段落
在要嵌套的段落前添加一个 >> 符号
带其他元素的块引用 在引用块中正常加入即可 块引用可以包含其他 Markdown 格式的元素大部分都能
有序列表 1. 第一项
2. 第二项
要创建有序列表请在每个列表项前添加数字并紧跟一个英文句点数字不必按数学顺序排列但是列表应当以数字 1 起始
无序列表 - 列表项

* 列表项

+ 列表项
要创建无序列表请在每个列表项前面添加破折号 (-)星号 (*) 或加号 (+) 缩进一个或多个列表项可创建嵌套列表
带其他元素的列表 在列表中正常加入即可 要在保留列表连续性的同时在列表中添加另一种元素请将该元素缩进四个空格或一个制表符
代码  `代码` 要将单词或短语表示为代码请将其包裹在一对反引号 ``
代码块 代码块 在代码块之前和之后的行上使用三个反引号(```)或三个波浪号~~~在代码块之前的反引号旁边指定一种语言可以对应高亮
分割线 ***
或—
或___
要创建分隔线请在单独一行上使用三个或多个星号 (***)破折号 (—) 或下划线 (___) 并且不能包含其他内容为了兼容性请在分隔线的前后均添加空白行
链接 [超链接显示名](超链接地址 "超链接title") 链接文本放在中括号[]内链接地址放在后面的括号()中链接title(悬停时出现的文字)可选
网址和Email地址 <网址> 使用尖括号可以很方便地把URL或者email地址变成可点击的链接
图片 ![图片alt](图片链接 "图片title") 要添加图像请使用感叹号 (!), 然后在方括号增加替代文本图片链接放在圆括号括号里的链接后可以增加一个可选的图片标题文本
表格 |表头1|表头2|   | ---| ---|     |表项1|表项2| 要添加表请使用三个或多个连字符创建每列的标题并使用竖线(|)分隔每列
您可以选择在表的任一端添加竖线通过在标题行中的连字符的左侧右侧或两侧添加冒号:将列中的文本对齐到左侧右侧或中心
任务列表 - [] 未完成任务
- [x] 已完成任务
要创建任务列表请在任务列表项之前添加破折号-和方括号[ ]并在[ ]前面加上空格要选择一个复选框请在方括号[x]之间添加 x
引用类型链接 第一部分[文本] [数字或字母或标点符号]
第二部分[第一部分第二个括号的内容]: https://网址
第一部分中第一组方括号包围应显示为链接的文本第一组和第二组方括号之间包含一个空格第二组括号显示了一个标签该标签用于指向您存储在文档其他位置的链接
可以将链接的第二部分放在Markdown文档中的任何位置
第二部分中1.放在方括号中的标签其后紧跟一个冒号和至少一个空格例如[label]: 2.链接的URL可以选择将其括在尖括号中3.链接的可选标题可以将其括在双引号单引号或括号中
脚注 正文[^1]正文
[^1]: 脚注内容
要创建脚注参考请在方括号[^1]内添加插入符号和标识符标识符可以是数字或单词但不能包含空格或制表符在括号内使用另一个插入符号和数字添加脚注并用冒号和文本[^1]: 脚注内容.您不必在文档末尾添加脚注您可以将它们放在除列表块引号和表之类的其他元素之外的任何位置
emoji 复制和粘贴表情符号😀

使用表情符号简码:符号简码:
以冒号开头和结尾并包含表情符号的名称这是简码列表

此外Markdown还支持html语言需要编辑器支持例如

<!--居中显示带链接的图片-->
<div align=center>
  <a href="链接">
    <img src="图片链接">
  </a>
</div> 

Markdown公式

markdown的数学公式分为行内公式行间公式(有的编辑器不支持)使用行内公式会让你的公式和之前的文字处于同一行 使用行间公式会对之前的文字换行然后公式单独成行并居中显示

行内公式$ Latex行内公式$

行间公式$$ Latex行间公式$$

常用公式

上角标 $ x^n$$\rightarrow x^2$

下角标 $ x_n$$\rightarrow x_n$

上划线$ \overline{abc}$$\rightarrow \overline{abc}$

下划线$ \underline{abc}$$\rightarrow \underline{abc}$

竖线$ \vert$$\rightarrow \vert$

模值$ \| i \| $$\displaystyle \rightarrow \|i\|$

乘号$ \times$$\rightarrow \times$

除号$ \div$$\rightarrow \div$

点乘内积$ \odot 或 \cdot$$\rightarrow \odot \ \cdot $

叉乘交叉积$ \otime 或 \times $$\rightarrow \otimes\ \times$

平方根$ \sqrt{x}$$\displaystyle \rightarrow \sqrt{x}$

{ }中的内容视为总体

n次根$ \sqrt[n]{x}$$\displaystyle \rightarrow \sqrt[n]{x}$

分式$ \frac{x}{y}$$\rightarrow \frac{x}{y}$

求和$ \sum_{k=1}^n$$\rightarrow \sum_{k=1}^n$

求积$ \prod_{k=1}^n$$\rightarrow \prod_{k=1}^n$

积分$ \int_a^b$$\rightarrow \int_a^b$

围线积分$ \oint$$\rightarrow \oint$

二重积分$ \iint$$\rightarrow \iint$

三重积分$ \iiint$$\rightarrow \iiint$

箭头

  • 左箭头$\leftarrow \Leftarrow$ $\leftarrow\ \ \ \Leftarrow$

  • 右箭头$ \rightarrow \Rightarrow$ $\rightarrow\ \ \ \Rightarrow$

  • 双向箭头$ \leftrightarrow \Leftrightarrow$ $\leftrightarrow\ \ \ \Leftrightarrow$

无穷$ \infty$$\rightarrow \infty$

极限$ \lim_{0\rightarrow \infty} $\rightarrow \lim_{0\rightarrow\infty}$

偏导$ \partial$ $\rightarrow \partial$

哈密顿算子$ \nabla$$\rightarrow \nabla$

任意$ \forall$$\rightarrow \forall$

存在$ \exists$$\rightarrow \exists$

正负号$ \pm 或 \mp$$\rightarrow \pm \ \mp$

大于等于$ \geq$$\rightarrow \geq$

小于等于$ \leq$$\rightarrow \leq$

约等于$ \approx$$\rightarrow \approx$

不等于$ \neq$$\rightarrow \neq$

属于$ \in$$\rightarrow \in$

不属于$ \notin$$\rightarrow \notin$

子集$ \subseteq$$\rightarrow \subseteq$

真子集$ \subset$$\rightarrow \subset$

角度度数$ \degree$$\rightarrow 360°$

角度$ \angle$$\rightarrow \angle 90°$


可以通过展示格式控制Markdown公式的大小\displaystyle显示格式公式较大

$ \displaystyle \sum_{k=1}^n \int_0^1$展现为$\displaystyle \sum_{k=1}^n \int_0^1$

$ \sum_{k=1}^n$展现为 $\sum_{k=1}^n \int_0^1$


分段函数

$$ 
函数名=\begin{cases}
公式1 & 条件1 \\
公式2 & 条件2 \\
公式3 & 条件3 
\end{cases}
$$

&符号用于对齐例如

$ W(x) = \begin{cases} (a+2)|x|^3-(a+3)|x|^2+1 & |x| \leq 1 \\ a|x|^3-5a|x|^2+8a|x|-4a & 1<|x|<2 \\ 0 & otherwise \end{cases}$

$ W(x) = \begin{cases} (a+2)|x|^3-(a+3)|x|^2+1 & |x| \leq 1 \\ a|x|^3-5a|x|^2+8a|x|-4a & 1<|x|<2 \\ 0 & otherwise \end{cases}$

矩阵

$\begin{pmatrix}
0&1&0\\
1&1&0\\
0&0&1\\
\end{pmatrix}$

注1pmatrix为小括号()包围bmatrix为中括号[]包围vmatrix为单竖线||包围
注2\cdots为横省略元素\vdots为竖省略元素\ddots为斜省略元素

例如

$ D = \begin{bmatrix} 2 \\ &3\\ &&2 \\ &&&3 \\ &&&&2 \end{bmatrix}$

$ \begin{bmatrix}
{a_{11}}&{a_{12}}&{\cdots}&{a_{1n}}\\
{a_{21}}&{a_{22}}&{\cdots}&{a_{2n}}\\
{\vdots}&{\vdots}&{\ddots}&{\vdots}\\
{a_{m1}}&{a_{m2}}&{\cdots}&{a_{mn}}\\
\end{bmatrix}$

$ D = \begin{bmatrix} 2 \\ &3\\ &&2 \\ &&&3 \\ &&&&2 \end{bmatrix}$


$\begin{bmatrix} {a_{11}}&{a_{12}}&{\cdots}&{a_{1n}}\\ {a_{21}}&{a_{22}}&{\cdots}&{a_{2n}}\\ {\vdots}&{\vdots}&{\ddots}&{\vdots}\\ {a_{m1}}&{a_{m2}}&{\cdots}&{a_{mn}}\\ \end{bmatrix}$

常用希腊字母
希腊字母 小写 大写 英语 发音
$\alpha\ A$ \alpha A alpha /'ælfə/
$\beta \ B$ \beta B beta /'bi:tə/ 或 /'beɪtə/
$\gamma \ \Gamma$ \gamma \Gamma gamma /'gæmə/
$\pi \ \Pi$ \pi \Pi pi /paɪ/
$\lambda \ \Lambda$ \lambda \Lambda lambda /'læmdə/
$\delta \ \Delta$ \delta \Delta delta /'deltə/
$\theta\ \Theta $ \theta \Theta theta /'θi:tə/
$\rho \ P$ \rho P rho /rəʊ/
$\sigma \ \Sigma$ \sigma \Sigma sigma /'sɪɡmə/
$\epsilon \ E$ \epsilon E epsilon /'epsɪlɒn/
$\zeta \ Z$ \zeta Z zeta /'zi:tə/
$\eta\ H$ \eta H eta /'i:tə/
$\phi \ \Phi$ \phi \Phi phi /faɪ/
$\psi \Psi$ \psi \Psi psi /psaɪ/
$\omega\ \Omega$ \omega \Omega omega /'əʊmɪɡə/ 或 /oʊ’meɡə/
$\tau \ T$ \tau T tau /tɔ:/or/taʊ/
$\kappa\ K$ \kappa K kappa /'kæpə/
$\mu\ M$ \mu M mu /mju:/
$\nu \ N$ \nu N nu /nju:/
$\xi\ \Xi$ \xi \Xi xi /ksi/ 或 /'zaɪ/ 或 /'ksaɪ/
$\omicron\ O$ \omicron O omicron /əu’maikrən/ 或 /'ɑmɪ,krɑn/
$\upsilon \ \Upsilon$ \upsilon \Upsilon upsilon /'ipsilon/ 或 /'ʌpsilɒn/
$\chi \ X $ \chi X chi /kaɪ/
常用函数名