Markdown For Typora中文文档

---

work by Albert

---

Markdown For Typora¹

概述

Markdown是由Daring Fireball所编写；它的最初的使用说明书在这里。但是，它的语法、变量在不同的解析器和编辑器中是不同的。Typora使用GitHub Flavored Markdown

块元素

段落和句子的断开

简单来说，一个段落是一句话或者是多个连续句子的组合。在Markdown的源码中，段落是由两条或者两条以上的空行来分割的。在Typora中，只需要一个空行（按一下回车键）就可以创建一个新的段落了。

按Shift+Enterke可以创建一个单独的行分隔符（不同于段分割符）。大多数的Markdown解析器会忽略单行作为分隔符，因此为了使其他的Markdown解析器能够识别你的行分隔符，你可以在行的末尾留两个空行，或者插入<br/>。

标题

对于标题的设置由1-6个hash(#)符号作为行的开始，对应于标题文字的六个等级。如下，

#  这是一级标题

## 这是二级标题

####### 这是六级标题

在Typora中，输入’#'加上标题内容，再按下回车键就可以成功创建标题了。

块引用

Markdown使用电子邮件风格的>符来创建块引用。如下：

> 这是含有两个段落的块引用。这是第一段。
> 
>这是第二段。尽是些看不懂的话


>这是含有一个段落的另一个块引用。两个块引用之间用三个空行来分割。

效果如下：

这是含有两个段落的块引用。这是第一段。

这是第二段。尽是些看不懂的话

这是含有一个段落的另一个块引用。两个块引用之间用三个空行来分割。

在Typora中，输入符’>‘加上所用引用的内容会生成一个引用块。Typora随后会为你插入一个合适的’>‘或者行分隔符。嵌套的块引用（在一个块引用中嵌入另一个块引用）是通过增加额外的’>'来实现。

列表

输入*list item 1会创建一个无序列表——*符可以用+或者-替代。

输入*1. list item 1会创建一个有序列表——它们的markdown源码如下：

**无序列表**
* Red
* Green
* Blue

**有序列表**
1. Red
2. Green
3. Blue

显示效果如下：

无序列表

• Red
• Green
• Blue

有序列表

1. Red
2. Green
3. Blue

任务列表

任务列表可以用来标记[]或者[x] (分别代表未完成和完成)。如下：

- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formattong**,@mentions,#1234
refs
- [ ] incomplete
- [x] completed

显示效果如下：

• a task list item
• list syntax required
• normal formattong,@mentions,#1234
  refs
• incomplete
• completed

你可以通过点击内容前的检查框来改变完成/未完成状态。

(Fenced)代码块

Typora只支持GitHub Flavored Markdown中的围栏。不支持Markdown中的原始代码块。

使用围栏的方法很简单：输入并按下`enter`。在之后添加语言的名称，Markdown会对代码中的关键字进行高亮：

举个例子：

​```
function test() {
  console.log("notice the blank line before this function?");
}
​```

语法高亮：
​```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
​```

显示效果如下：

举个例子：

function test() {
  console.log("notice the blank line before this function?");
}

语法高亮：

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

数学块

用户可以使用MathJax来渲染LaTeX数学表达式。

输入$$然后按enter键，可以添加数学表达式。上述命令会触发一块能接受Tex/LaTex表达式的区域。例如：
$${\mathbf{v}}_1\times {\mathbf{v}}_2=\left|\begin{array}{ccc}\mathbf{i}& \mathbf{j}& \mathbf{k}\\ \frac{\partial X}{\partial u}& \frac{\partial Y}{\partial u}& 0\\ \frac{\partial X}{\partial v}& \frac{\partial Y}{\partial v}& 0\end{array}\right|$$
更多细节可以在这里查询。

表格

输入| First Hesder | Second Header |并按下enter键。上述操作会创建一个有两列的表格。

在表格被创建之后，表格会打开一个工具条。使用该工具条可以实现表格的重塑、对齐和删除。你也可以使用语境目录来复制和添加/删除独立的列/行。

创建一个表格的所有语法如下，但是没有必要去知道所有详细的语法。因为生成一个表格的markdown源码会有Typora自动生成。

在markdown的源码中，生成表格的源码如下：

|	first Header	|	Second Header	|
|-------------------|-------------------|
|	Content Cell	|	Content Cell	|
|	Content Cell	|	Contnet Cell	|

显示效果如下：

first Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

在表格中依旧可以使用在线Markdown比如，链接、加粗，斜体，或者删除线。

最后，通过在表头行中添加冒号（:）可以实现文字在表格中的左对齐，右对齐或者中间对齐：

|	Left-Aligned	|	Center Aligned	|	Right Aligned	|
|	:-----------	|	:-------:		|	------------:	|
|	col 3 is		|	some wordy text	|	$1600			|
|	col 2 is		|	centered		|	$12				|
|	zebra stripes	|	are neat		|	$1				|

Left-Aligned	Center Aligned	Right Aligned
col 3 is	some wordy text	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

脚注

我们可以像这样来创建脚注[^脚注].
[^脚注]:Here is the *text* of the **footnote**.

显示效果如下：

我们可以像这样来创建脚注².

将鼠标悬停在’脚注‘上标上可以查看脚注的内容。

水平分隔线

在空白行输入***或者---并按下enter键将会画出一条水平线。

***

显示效果如下：

---

YAML Front Matter

Typora现在支持YAML Front Matter。在文章的顶部输入---然后按下enter键会引出一个元数据块。或者，用户也可以在Typora的顶端目录插入元数据区。

目录表格（TOC）

输入[TOC]并按下enter键。上述操作会创建一个“目录表格”部分。TOC会从文档中提取出所有的标题，它的内容会随着用户向文档增加内容而自动更新。

延展性元素

在输入之后延展性元素会被正确的解析和渲染。将光标移到那些延展性元素中间会将这些元素拓展到markdown源。接下来是对于每一个延展性元素的语法解释。

链接

Markdown支持两种风格的链接：行内式和参考式。

在两种风格的链接中，链接文字都被写在[方括号]中。以及作为链接可选项的标题，标题由引号引起开。例如：

这是一个行内链接的[例子](http://example.com/ "Title")。

这个[例子](http://example.com/)没有标题这个量。

显示效果如下：

这是一个行内链接的例子。

这个例子没有标题这个量。

行内链接

用户可以设置一个指向标题的herf。这个可以创造一个允许你在点击之后跳向所指向的那部分。
例如：

（在Windows系统中）Ctrl+点击这个链接将会跳转到标题BlockElements。读者可以按住Ctrl键并点击该链接来查看该元素的markdown源码，以学习如何编写该操作。

参考链接

参考链接会用到两个方括号，在第二个方括号中放入你所选择的指向特定链接的标签。

这是一个关于参考式链接的[例子][id]。

之后，你可以在文档的任意一个地方，定义你的链接标签，如下：
[id]:http://example.com/  "Optional Title Here"

渲染效果如下：

这是一个关于参考式链接的例子。

之后，你可以在文档的任意一个地方，定义你的链接标签，如下：

这之中含蓄的链接名便捷方法可以让你略去链接的名称，在这种情况下，链接的本身是用它的名字来代替的。也将对二个方括号置空——例如，将单词‘Google’链接到google.com,你可做如下操作：

[Google][]
之后再定义链接：

[Google]:http://google.com/

渲染效果如下：

Google
之后再定义链接：

在Typora中，点击链接会将它拓展开用于编辑。ctrl+点击会在浏览器中打开这个超链接。

URLs

Typora允许用户插入URLs作为链接，用<尖括号>括起来。

<[e-mail]>会变成[e-mail]。

Typora会自动的链接标准的URLs，例如:www.google.com

图片

图片的引用于链接的语法相似，但是它们需压在链接的开头添加一个!符。插入一张照片的语法如下：

![随机](C:\Users\admin\Desktop\pic.png)
![随机](C:\Users\admin\Desktop\pic.png title")

显示效果如下：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2SsqaGEo-1580115223928)(C:\Users\admin\Desktop\pic.png)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LGEZuyg7-1580115223933)(C:\Users\admin\Desktop\pic.png “title”)]

你可以利用drag&drop从本地的图像文件加或者你的浏览器插入一张图片。你可以通过点击图片来修改markdown源码。如果被添加的图片和你正在编辑的文件是在相同的目录或者子目录下可以使用相对路径。

如果你使用markdown来搭建网站，你可以在你的本地计算机上以YAML Front Mater的形式设置typora-root-url属性，来为图片的预览指定一个URL前缀。例如，以YAML Front Matter形式输入typora-root-url:/User/Abner/website/typora.io/，之后![alt](/blog/img/test.png)将等同于![alt](file:///User/Abner/website/typora.io/blog/img/test.png)。

你可以在这里查询更多的信息。

强调

Markdown将星号(*)和下划线(_)作为强调的符号。由一个*或者_包裹的文字将会使用HTML<em>标签进行包装。例如，

*一颗星*
_一条下划线_

渲染效果如下：

一颗星
一条下划线

GMF会在单词中忽略下划线，它常用代码和名称，如下：

wow_great_stuff

do_this_and_do_that_and_another_thiing.

如果想要在某个位置单纯输入星号或者下划线，在这里你除了可以利用强调界定符，还可以使用反斜杠进行转义：

\*这是一句被单纯的星号包围的句子。\*

效果如下：

*这是一句被单纯的星号包围的句子。*

Typora推荐使用*标志。

加粗

被两颗星*或者两个下划线_包裹的文字内容会被HTML的<strong>标签包装，例如：

**两颗星**
__两条下划线__

渲染效果如下：

两颗星
两条下划线

代码

我们可以使用反引号(`)来标明行内的代码条。和之前的预格式化的代码块不同，被标明的代码条实在普通的段落中的。例如，

使用`print（）`函数

渲染效果如下：

使用print（）函数

删除线

GFM添加了删除线的语法，这在标准的Markdown中是不存在的。

~~错误文字~~会变成 错误文字。

下划线

对于下划线的支持是来自于原生的HTML。

<u>下划线</u>会变成下划线。

Emoji

输入emoji的语法是：:smile:。

用户可以通过按esc键来触发对于emoji的自动补全建议。通过(macOS)菜单栏Edit->Emoji & Symbol直接输入UTF-8emoji符号也是支持的。

行内数学式

想要使用该功能，首先应在偏好设置->markdown中确认它存在。然后利用$来包裹Tex命令。例如：$\lim_{x\to\infty}\exp(-x)=0$将会被渲染成LaTex命令。

在先预览行内数学式的方法是：输入“$”,然后按下ESC键，再输入Tex命令。

读者可以在这里了解更多详细信息。

下标

想要使用该功能，首先应在偏好设置->markdown中确认它存在。然后使用~来包装下标内容。例如：H~2~o,X~long\ text~/

上标

想要使用该功能，首先应在偏好设置->markdown中确认它存在。然后使用^来包装上标内容。例如，X^2^。

高亮

想要使用该功能，首先应在偏好设置->markdown中确认它存在。然后使用==来包装上标内容。例如，==高亮==。

嵌入内容

一些网站提供基于iframe的嵌入式代码，用户可以将其粘贴到Typora中。例如：

<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>

视频

用户可以利用HTML中的<video>标签来插入视频文件。例如：

<video src="xxx.mp4" />

其他的HTML支持

读者可以在这里了解更多详细信息。

---

1. 本文内容是Typora官方参考文档的翻译。因本人水平有限，文中可能存在不足之处，望指正。 ↩︎

2. Here is the text of the footnote. ↩︎