Markdown Reference

Markdown 参考指南

Overview

Markdown is created by Daring Fireball; the original guideline is here. Its syntax, however, varies between different parsers or editors. Typora is using GitHub Flavored Markdown.

块元素

段落和换行符

段落： 段落是指>1行的连续不间段文字。

换行符: 用来做段落区分，通常由两行空行组成，在 typora 中，用 Return|Enter 即可创建一个换行符。

单换行符: 使用 Shift + Return|Enter 进行单换行符，从 markdown 原语上不支持单换行符，所以为了和其他解析器兼容，建议在行尾添加两个空格或者直接插入使用 html 标签 <br/>

这是段落1，后面跟一种单换行符
这是段落1的第二行，后面跟了另一种单换行符
这是段落1的第三行，后面跟了一个换行符。

这是段落2，后面跟了 typora 的单换行符。这是段落1的第二行，后面跟了换行符。

标题

使用 1-6 个 # 符号放置在行首，对应了级别为 1-6 的标题 例如：

markdown
# This is H1

## This is H2

### This is H3

#### This is H4

This is H1

This is H2

This is H3

This is H4

引用

符号 > 置于行首用来表示引用，例如：

markdown
> 这是对一个有两段文字的引用，这是第一段。
>
> 这是第二段，nonsense words, nonsense words, nonsense words, nonsense words

> 这是另一个引用，两个引用之前使用三个空行用以分隔。

这是对一个有两段文字的引用，这是第一段。

这是第二段，nonsense words, nonsense words, nonsense words, nonsense words

这是另一个引用，两个引用之前使用三个空行用以分隔。

列表

符号 * 置于行首用于创建一个元序数的列表，同样的，你也可以使用 + 或 - 符号。

markdown
#### un-ordered list

- Red
  - pink
    - light pink
    - heavy pink
  - orange
- Green
- Blue

#### ordered list

1. Red 1.1 pink 1.2 light pink 1.3 heavy pink
2. Green
3. Blue

un-ordered list

  • Red
    • pink
      • light pink
      • heavy pink
    • orange
  • Green
  • Blue

ordered list

  1. Red
    1.1 pink
    1.2 light pink
    1.3 heavy pink
  2. Green
  3. Blue

任务列表 (typora)

任务列表用- [ ] (未完成) 或 - [x] (完成) 来表示，例如：

markdown
- [ ] TODO 1
- [ ] TODO 2
- [ ] TODO **importatnt**, @mentions, #1234 refs
- [ ] 未完成
- [x] 已完成

  • TODO 1

  • TODO 2

  • TODO important, @mentions, #1234 refs

  • 未完成

  • 已完成

代码块

用以下格式来表示代码块:

plaintext
```markdown
代码块中的内容不仅可以用来表示代码，也可以用来包括一切不需要解析的纯文本。比如 <br/> 在此处不会换行，

# 一级标题不生效

> 引用也没有作用
```
markdown
代码块中的内容不仅可以用来表示代码，也可以用来包括一切不需要解析的纯文本。比如 <br/> 在此处不会换行，

# 一级标题不生效

> 引用也没有作用

数学块

大多数 markdown 解析引擎使用 MathJax 渲染 LaTeX 格式的数学表达式。

通过 $$ + Return 的方式添加 Tex/LaTex 表达式。例如：

markdown
$$
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
{\partial}X \over {\partial u} & \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial u} & 0 \\
\end{vmatrix}
$$
V1×V2=∣ijk∂X∂u∂Y∂u0∂X∂v∂Y∂u0∣\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix} \mathbf{i} & \mathbf{j} & \mathbf{k} \\ {\partial}X \over {\partial u} & \frac{\partial Y}{\partial u} & 0 \\ \frac{\partial X}{\partial v} & \frac{\partial Y}{\partial u} & 0 \\ \end{vmatrix}

更多内容参见，Math and Academic Functions

表格

表格的格式如下：

markdown
| Column 1       |    Column 2    |       Column 3 |
| :------------- | :------------: | -------------: |
| column 1 row 1 | column 2 row 1 | column 3 row 1 |
| column 1 row 2 | column 2 row 2 | column 3 row 2 |
| 左对齐         |    居中对齐    |         右对齐 |
Column 1Column 2Column 3
column 1 row 1column 2 row 1column 3 row 1
column 1 row 2column 2 row 2column 3 row 2
左对齐居中对齐右对齐

注解 (Footnotes)

创建注释的格式如下：

markdown
你可以像这样创建一个注解[^注解].

[^注解]: 这里是**注解**的*说明文字*。

你可以像这样创建一个注解1。

分隔线

用 --- + Return 或者 *** + Return 可以生成一条分隔线。

目录 (TOC)

[TOC]

行内元素

链接

创建一个超链接的方式如下：

markdown
这是一个 [bing搜索](https://cn.bing.com/ '链接的标题') 有标题的链接。这是一个 [bing搜索](https://cn.bing.com/) 无标题的链接。

这是一个 bing搜索 有标题的链接。这是一个 bing搜索 无标题的链接。

内部链接

内部链接指向文章内部，他使得用户在点击后可以跳转相应的标题，例如：

markdown
这是一个 [目录 (TOC)](#目录 'TOC') 有标题的链接。

这是一个 目录 (TOC) 有标题的链接。

引用链接

引用链接通过两个 [] 方括号来表示，在第二个 [] 方括号内用一个标签来标识，例如：

markdown
这是一个 [bing搜索][2] 无标题的链接。

#隐式链接的特点是第二个 [] 内不需要写标签，其标签就是第一个 [] 的内容。这个一个 [bing搜索][] 的隐式链接。

# 这个链接一般写在文章末尾

[2]: https://cn.bing.com/  [bing搜索]: https://cn.bing.com/

这是一个 bing搜索 无标题的链接。

这个一个 bing搜索 的隐式链接。

URLs

如果只需要写纯链接，可以直接将链接写到 <> 两个尖括号之前，例如：

https://google.com

m@in404.com

Images

图片的 markdown 原语格式和超链接很像，如下：

markdown
![Alt text](/path/to/image.png) ![Alt text](/path/to/image.png 'Optional title')

drag-img

斜体强调

通过在文字两边加上 _ 下划线 或 * 单星号，来形成强调格式，等同于 html 语法中的 <em> 标签，例如：

单星号的强调

下划线的强调

如果需要专门显示特殊字符，可以用 \ 前置于特殊字符之前，比如：这是 _下划线_ 这是 *单星号*。

加粗强调

与斜体强调类似，通过在文字两边加上 __ 两个下划线 或 ** 两个星号完成，等同于 html 语法中的 <strong> 标签。

双下划线的强调

双星号的强调

代码

行内的代码元素通过在文字两边加上 ` 符号来完成，例如：

markdown
在 Java 中打印到标准输出流，我们需要使用 `System.out.println()` 方法。

在 Java 中打印到标准输出流，我们需要使用 System.out.println() 方法。

删除线

删除线通过在文字两边加上 ~~ 两个破折号完成，例如：

xrange() 方法在 python 3 中已经被废弃了。

下划线

typora 中下划线直接通过 html 原语来实现，即 <u> 标签。

markdown
<u>此处下划线</u>

此处下划线

表情符号 (Emoji)

通过 :{label}: 来完成表情符号，如:

markdown
:happy::car:

:happy::car:

输入 : 加一个任意字符后会自动提词，mac 上最好用的方法是 ^ + cmd + space, 也可以直接查 Emoji Table

行内数学符号

把表达式写在 $ 美元符号之前即可。

markdown
$\lim_{x \to \infty} \exp(-x) = 0$

lim⁡x→∞exp⁡(−x)=0\lim_{x \to \infty} \exp(-x) = 0

下标

先在偏好设置里打开，将需要变成下标的元素放在两个 ~ 破折号之间。

Xlong\ textY H2O CO2

上标

先在偏好设置里打开，将需要变成上标的元素放在两个 ^ 符号之间。

x^2^ + 2x = 2y^2^

高亮

先在偏好设置里打开，将需要变成高亮的元素放在两个 == 符号之间。

==这是一段高亮文字==

HTML

markdown 语法里支持了大部分原生 html 标签，所以内联的 html 类型基本都可以直接使用，例如:

html
<span style="color:red">this text is red</span>

<div style="background:red;">
  <a href="https://google.com">GOOGLE</a>
</div>

<iframe
  height="265"
  scrolling="no"
  title="Fancy Animated SVG Menu"
  src="http://codepen.io/jeangontijo/embed/OxVywj/?height=265&theme-id=0&default-tab=css,result&embed-version=2"
  frameborder="no"
  allowtransparency="true"
  allowfullscreen="true"
  style="width: 100%;"
></iframe>

<video src="xxx.mp4" />

this text is red

GOOGLE