概览
Markdown 由 Daring Fireball 创造;原指导文档在 这里。然而,与大多数解释器 / 编辑器不同的是,Typora 采用的是 Github 推荐的 Markdown。
Block 元素
段落和换行
一个段落是简单的一行或者多个的连续行。在 markdown 源码中,段落被两个或多个空白行分隔。在 Typora 中,你仅需要一个空白行即可(按一次 Return
)创建一个新段落。
按住 Shift
+ Return
可以仅创建一次换行。大多数其他 markdown 解释器会忽略单独换行,所以为了让其他 markdown 解释器识别你的换行,你可以在一行的结束留两个空格,或插入 <br/>
。
标题
标题为在一行的开始使用 1-6 个 #
号,对应为 1-6 级标题。例如:
# This is an H1
## This is an H2
###### This is an H6
复制代码
在 Typora 中,在标题前输入 #
,然后按 Return
键创建一个标题。
块引用
Markdown 使用 email 风格的 > 符号进行块引用。如下所示:
> This is a blockquote with two paragraphs. This is first paragraph.
>
> This is second pragraph. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> This is another blockquote with one paragraph. There is three empty line to seperate two blockquote.
复制代码
在 Typora 中输入 >
然后紧跟你的引用内容将会生成一个引用块。Typora 可以为你继续插入一个 >
符号或者为一个换行。嵌套块引用(一个块引用嵌套在另一个块引用中)通过添加高一级的 >
。
列表
输入 * list item 1
将会创建一个无序列表 —— *
符号可以用 +
或 -
替代。
输入 1. list item 1
将会创建一个有序列表。markdown 源码如下所示:
## un-ordered list
* Red
* Green
* Blue
## ordered list
1. Red
2. Green
3. Blue
复制代码
任务列表
任务列表是通过符号 [] 或 [x](未完成或完成)进行标记的列表。例如:
- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formatting**, @mentions, #1234 refs
- [ ] incomplete
- [x] completed
复制代码
你可以通过点击标签前的检查框进行勾选来改变完成 / 未完成状态。
代码块
Typora 仅支持 GitHub Flavored Markdown (GFM) 的代码块(fences)。原始 markdown 的代码块不支持。
使用 fences 是非常简单的:输入 ``` 然后按 return
键。添加一个可选的语言标识符在 ``` 之后可打开语法高亮:
Here's an example:
```
function test() {
console.log("notice the blank line before this function?");
}
```
syntax highlighting:
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
复制代码
数学公式块
你可使用 MathJax 提供 LaTeX 数学表达式。
添加一个数学表达式,输入 $$
然后按回车键。将创建一块用以接收 Tex/LaTex 源码的输入区域。例如:
在 markdown 源文件中,数学公式块是被一对 ‘$$’ 标记所包围的一个 LaTeX 表达式:
$$
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\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{vmatrix}
$$
复制代码
你可以在 这里 找到更多细节。
表
输入 | First Header | Sceond Header |
然后按 return
键,将创建一个具有两列的表格。
在一个表被创建后,点击该表可以打开工具栏,用以重设表格大小,列对齐方式或删除。同样可以使用上下文菜单复制和添加 / 删除单独的行 / 列。
创建表的全部语法如下所示,但是不必了解所有的语法细节因为 Typora 可以自动生成 Markdown 表格的源代码。
在 Markdown 源代码,语法如下所示:
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
复制代码
表格内可包含链接,可对表中文本设置加粗,斜体或删除线。
最后,通过在标题行包含冒号(:),你可以定义该列文本的对齐方式。
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
复制代码
冒号在最左边表示左对齐;冒号在最右边表示右对齐;冒号在两边表示居中对齐。
脚标
You can create footnotes like this[^footnote].
[^footnote]: Here is the *text* of the **footnote**.
复制代码
将产生:
你可以像这样创见脚标 [1]。
鼠标停留在在 footnote
可以看到该脚标的内容。
水平分割线
在空白行输入 ***
或 ---
然后按 return
键将创建一条水平分割线。
YAML Front Matter
Typora 现在支持 YAML Front Matter。在文章顶部输入 ---
然后按 Return
键将引入一个元数据块。另外,你可以从 Typora 菜单栏插入一个元素据块。
目录(TOC)
输入 [toc]
然后按 Return
键,将创建一个目录。TOC 提取文档内的所有标题,然后自动在该文档首部形成一个目录。
Span 元素
Span 元素在输入后将被立即解析和显示。将鼠标移动到这些 span 元素上将会显示这些元素的源代码。下面是每个 span 元素的语法。
链接
Markdown 支持两种方式的链接:内联链接和引用链接。
在两种形式中,链接文本都被包含在 [] 中。
创建内联链接,是在链接文本的方括号后紧跟一对小括号,用以放入一个你想指向的链接的 URL,和一个可选的用引号包围的链接标题。如下:
This is [an example](http://example.com/"Title") inline link.
[This link](http://example.net/) has no title attribute.
复制代码
将会创建:
This is an example inline link. (<p>This is <a href="http://example.com/"title="Title">
)
This link has no title attribute. (<p><a href="http://example.net/">This link</a> has no
)。
内部链接
你可以设置 href 链接至标题,将创建一个允许你点击后跳转至目的区域的链接。例如:
Command(Windows: Ctrl) + 点击 [此链接](#Block 元素) 将跳转至标题 Block 元素
。点击该链接将显示 markdown 源码。
引用链接
引用链接使用两对方括号,包括一个你选择用来标识该链接的标签:
This is [an example][id] reference-style link.
Then, anywhere in the document, you define your link label on a line by itself like this:
[id]: http://example.com/ "Optional Title Here"
复制代码
在 Typora 中, 如下显示:
This is an example reference-style link.
当链接文本和链接标签相同时,可省略第二个方括号内的链接标签。例如,只要用一对空方括号,就可将单词 "Google" 链接至 google.com:
[Google][]
And then define the link:
[Google]: http://google.com/
复制代码
在 Typora 中,点击该链接可以进行修改,并且 command+click 将在你的浏览器中打开此超链接。
URLs
Typora 允许你插入 URLs 作为链接, 使用 <>
将该 URLs 包围即可。
<i@typora.io>
显示为 i@typora.io 。
Typora 可为标准 URLs 自动产生链接。例如:www.google.com。
图片
图片和链接具有相似的语法,只需要在链接的语法前加入一个额外的 !
。图片插入的语法如下所示:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg"Optional title")
复制代码
你可以从一个图片文件或者你的网页浏览器中通过拖/放的方式插入一个图片。通过点击此图片便可修改 markdown 源码。如果此图片是通过拖/放方式插入的,并且属于你正在编辑文档的目录或者子目录,Typora 将会采用相对路径。
斜体
Markdown 将星号 *
和下划线 _
作为斜体的标识符。被星号和下划线包围的文本就和被 HTML 中的 em
标签包围的文本效果一样。例如:
*single asterisks*
_single underscores_
复制代码
输出:
single asterisks
single underscores
GFM 将会忽略广泛使用在编程和命名中的单词的下划线,例如:
wow_great_stuff
do_this_and_do_that_and_another_thing.
为了表示一个文本的星号或者下划线,你可以使用 \ 进行转义:
\*this text is surrounded by literal asterisks\*
复制代码
Typora 推荐使用 *
符号。
加粗
两对 *
或 _
可以使其包围的内容加粗,就和被 HTML 的 <strong>
标签包围的效果一样。
**double asterisks**
__double underscores__
复制代码
输出:
double asterisks
double underscores
Typora 推荐使用 **
符号。
编程
为了表示行内代码片,使用右单引号(`)。不像格式化代码块,一个代码片是在一个正常段落中显示的,例如:
Use the `printf()` function.
复制代码
将产生:
Use the printf()
function.
删除线
GFM 包含了为文本添加删除线的语法,此语法在标准 Markdown 语法不存在。
~~Mistaken text.~~
显示为 Mistaken text.
下划线
下划线使用原生 HTML 语法。
<u>Underline</u>
显示为 Underline.
Emoji :smile:
使用语法 :smile
输入 emoji 表情。
用户可以通过按下 ESC
键启用 emoji 的自动补全建议,或在首选项中启用。在(macOS)菜单栏中 Edit
-> Emoji & Symbols
,直接输入 UTF-8 emoji 字符同样是被支持的。
行内数学公式
使用该特性前,请先打开 Preference
Panel -> Markdown
Tab。然后使用 $
包围一个 TeX 命令。例如: $\lim_{x \to \infty} \exp(-x) = 0$
将被视为一个 LaTeX 命令。
为行内数学公式开启行内预览:输入 "$",然后按下 ESC
键,然后输入一个 TeX 命令。
你可以在这里找到更多细节 here。
下标
使用该特性前,先打开 Preference
Panel -> Markdown
Tab,然后使用 ~
包围下标内容,例如: H~2~O
, X~long\ text~
。
上标
使用该特性前,先打开 Preference
Panel -> Markdown
Tab,然后使用 ^
包围上标内容,例如: X^2^
。
高亮
使用该特性前,先打开 Preference
Panel -> Markdown
Tab,然后使用 ==
包围高亮内容,例如: ==highlight==
。
HTML
当纯 Markdown 语法不支持时,你可以使用 HTML 个性化内容。例如:使用 <span style="color:red">this text is red</span>
将文本设置为红色。
嵌入内容
一些网站提供基于 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>
复制代码
视频
你可以使用 <video>
HTML 标签插入视频。例如:
<video src="xxx.mp4"/>
复制代码
其他 HTML 支持
你可以在这里找到更多细节 here.
Here is the text of the footnote. ↩︎