• 认真地记录技术中遇到的坑!

Markdown文本标记语言语法

其他 悠悠 2年前 (2017-08-04) 939次浏览 0个评论

Markdown是一个文本标记语言,经常用来写API文档等。在线编辑: MaHuaStackedit,强烈推荐 Stackedit,一个功能很强大的在线 Markdown 编辑网站。

比较好的markdown语法参考网站:http://www.markdown.cn/

绘图组件:https://mermaidjs.github.io/usage.html

文字强调

可以通过在一行的末尾加 2个空格 再换行实现换行。

  1. 斜体:*内容*, _内容_
  2. 粗体:**内容**
  3. 加粗斜体:***内容***
  4. 删除线:~~内容~~
  5. 高亮:`内容`
不同的Markdown解析器解析的结果略有不同,展现形式也略有差异,这是很正常的。

标题

一共可以表示六级标题,可以用 # 加空格表示,也可以用 HTML 标签表示。使用 [TOC] 可以引用标题生成目录。

  1. 一级标题:#
  2. 二级标题:##
  3. 三级标题:###
  4. 四级标题:####
  5. 五级标题:#####
  6. 六级标题:######
  7. 使用单独占一行的 ===== 分割线表示一级标题
  8. 使用单独占一行的 – – – – –  分割线表示二级标题

超链接

[]里写链接文字,()里写链接地址, ()中的”“中可以为链接指定title属性,title属性可加可不加。链接地址与链接标题前有一个空格。锚点定义和标题间有一个空格。

  1. 行内式:[链接文字](链接地址 “链接标题”)
  2. 参考式:[链接文字][链接标记]
  3. 直接链接:<链接地址>
  4. 锚点链接:[链接文字](#链接锚点id)
超链接[悠悠](http://uusama.com "悠悠")
常用的网址有:[悠悠][1], [百度][2], [谷歌][3]
[1]:http://uusama.com "个人博客"
[2]:http://baidu.com "百度"
[3]:http://google.com "Google"
<http://uusama.com>
<h1 id="catalog_1">1.第一个目录</h1>
# 2.第二个目录 {#catalog_2}
点击跳转到[第一个目录](#catalog_1)
点击跳转到[第一个目录](#catalog_2)

插入图片

  1. 行内式:![图片Alt](图片地址 “图片Title”)
  2. 参考式:![图片Alt][标记],  [标记]:图片地址 “Title”

列表

  1. 使用 *,+,- 表示无序列表
  2. 使用序号 1. 2. 3 表示有序列表
  3. 使用 >, >>, >>> 表示缩进列表
  4. 使用 : 表示定义型列表

使用 *,+,- 表示无序列表。如果你的解析器没有效果,需要在 * 前面添加一个空行。在 * 后面的空格是必需的,否则就只会显示 * 本身。使用 1. 2. 3. 等编号简单的标识有序列表,记得在英文点号后面添加空格。

- 第一项
- 第二项
- 第三项

添加四个空格缩进可以实现多级列表
* 1  
    * 1.1
    * 1.2

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

 > api 
 >> api_2
 >>> web 
 >> app_1 
 > qpp_2

Term 2
: Definition A
: Definition B
如果你发现现实没有效果,请检查必要的换行和空格是否添加。

表格

  1. 第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
  2. 列于列之间用管道符 | 隔开。原生方式的表格每一行的两边也要有管道符。
  3. 第二行还可以为不同的列指定对齐方向。默认为左对齐,在 – 右边加上 : 就为右对齐。
| Item     | Value | Qty   |
| :------- | ----: | :---: |
| Computer | $1600 |  5    |
| Phone    | $12   |  12   |
| Pipe     | $1    |  234  |
如果想在表格中插入竖线,可以使用HTML编码:&#124 ; 或者 &#x7C ; 来代替

代码块

使用两组每组三个反引号包裹代码块,两组三个反引号独占一行,在第一组反引号后可以指定代码语言格式。
还可以在每行缩进四个空格或一个制表符表示,一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。

```C
#include <stdio.h>
int main(void)
{
    printf("Hello world\n");
}
```
    #include <stdio.h>
    int main(void)
    {
        printf("Hello world\n");
    }
还可以在Markdown中直接插入HTML代码,有的解析器甚至支持流程图语法。

LaTex数学公式

使用两个 $ 符号包围数学公式,可以插入公式。在公式中会忽略空格。详细文档可以参考官方文档

上下标

  • 上标:^ 下标:_
  • 示例:C_n^2: C_n^2

分组

  • 标记:{}
  • 示例:x_{spce}^{y+1}:x_{spce}^{y+1}

向量

  • 标记:\vec,\overrightarrow
  • 示例:\vec a:\vec a ,\overrightarrow{xy}:\overrightarrow{xy}

括号

  • 小括号:()呈现为()
  • 中括号:[]呈现为[]
  • 尖括号:\langle,\rangle呈现为\langle,\rangle
  • 大括号:{}呈现为\{\}
  • 使用\left(或\right)使符号大小与邻近的公式相适应
  • (\frac{x}{y})呈现为(\frac{x}{y})
  • \left(\frac{x}{y}\right)呈现为\left(\frac{x}{y}\right)

常用公式标记

标记 作用 实例 效果
\frac, \over 分数 \frac{x+1}{y+n},x \over y \frac{x+1}{y+n}
\sqrt 开方根号 \sqrt[y]{x} \sqrt[y]{x}
\sum 累计求和 \sum_{i=1}^n{a_i} \sum_{i=1}^n{a_i}
\prod 累计求积 \prod_{i=0}^n \frac{1}{i^2} \prod_{i=0}^n \frac{1}{i^2}
\int 积分 \int_0^1 x^2 {\rm d}x \int_0^\infty x^2 dx
\lim 极限 \lim_{n \rightarrow +\infty} \frac{1}{n(n+1)} \lim_{n \rightarrow +\infty} \frac{1}{n(n+1)}
\sin, \ln, \log 特殊函数 \sin x, \ln x, \max(a,b,c) \sin x, \ln x, \max(a,b,c)

矩阵,整列,方程组

使用起始标记\begin{matrix},结束标记\end{matrix}包围一个矩阵。每一行末尾标记\,行间元素之间以&分隔。可以替换 matrix 部分,表示不同的边框,整列以及方程组。

  • pmatrix:小括号边框
  • bmatrix:中括号边框
  • Bmatrix:大括号边框
  • vmatrix:单竖线边框
  • Vmatrix:双竖线边框
  • array:阵列(需要array支持),效果类似于使用Vmatrix
  • cases:方程组

另外可以在矩阵中使用省略号:

  • \cdots:横排省略号
  • \vdots:竖省略号
  • \ddots:斜省略号

下面的标记:

  • \begin{Vmatrix}1&0&0\ 0&1&0\ 0&0&1 \end{matrix}
  • \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}
  • begin{cases}a_1x+b_1y+c_1z=d_1\a_2x+b_2y+c_2z=d_2\a_3x+b_3y+c_3z=d_3\end{cases}

分别呈现为:

\begin{bmatrix}1&0&0\\0&1&0\\0&0&1\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} \begin{cases}a_1x+b_1y+c_1z=d_1\\a_2x+b_2y+c_2z=d_2\\a_3x+b_3y+c_3z=d_3\end{cases}


转载请注明出处 Markdown文本标记语言语法
喜欢 (5)
发表我的评论
取消评论
表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址