Markdown Reference
Markdown For Typora
概览
Markdown由 Daring Fireball创建;原始指南在 这里。然而,其语法在不同的解析器或编辑器之间有所不同。Typora使用的是GitHub Flavored Markdown.
块级元素详解
段落和换行
段落是一行或多行连续的文本。在Markdown源代码中,段落由两个或更多的空白行分隔。在Typora中,只需要一个空白行(按一次回车键)即可创建一个新段落。
按Shift + 回车键
可以创建一个单独的换行。大多数其他Markdown解析器会忽略单独的换行,所以为了让其他Markdown解析器识别您的换行,您可以在行尾留两个空格,或者插入<br/>
。
标题
标题使用1-6个井号(#
)字符在行的开始,对应标题级别1-6。
例如:
在Typora中,输入井号#
后跟标题内容,然后按回车键即可创建标题。
# This is an H1
## This is an H2
###### This is an H6
引用
Markdown使用电子邮件风格的>
字符进行块引用。它们显示为:
在Typora中,输入>
后跟您的引用内容将生成一个引用块。Typora将为您插入适当的>
或换行。通过添加额外级别的>
来嵌套块引用(一个块引用内另一个块引用)。
> 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.
列表
输入* 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中的围栏。原始Markdown中的代码块不支持。
使用围栏很简单:输入 "```" 然后按回车。在后面添加可选的语言标识符,我们将通过语法高亮来运行它:
Here's an example:
```js
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表达式:
表格
输入| First Header | Second Header |
然后按回车键。这将创建一个两列的表格。
创建表格后,将焦点放在该表格上将打开一个表格工具栏,您可以在其中调整大小、对齐或删除表格。您还可以使用上下文菜单复制和添加/删除单个列/行。
表格的完整语法如下,但不需要详细了解完整的语法,因为Typora会自动生成表格的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 |
脚注
将产生:
您可以像这样创建脚注[^footnote]。
将鼠标悬停在‘脚注’上标以查看脚注的内容。
水平规则
在空行上输入***
或---
然后按回车键将绘制一条水平线。
YAML前言
Typora现在支持YAML前言。在文章顶部输入---
然后按回车键以引入一个元数据块。或者,您可以从Typora的顶部菜单插入一个元数据块。
目录(TOC)
输入[toc]
然后按回车键。这将创建一个“目录”部分。TOC从文档中提取所有标题,随着您向文档添加内容,其内容将自动更新。
内联元素详解
链接
Markdown支持两种风格的链接:内联和引用。
在这两种样式中,链接文本都由[方括号]分隔。
要创建内联链接,请在链接文本的右方括号后立即使用一组常规括号。在括号内,将URL放在您希望链接指向的位置,以及链接的可选标题,用引号括起来。例如:
这是[一个例子](http://example.com/"标题")内联链接。
[此链接](http://example.net/)没有标题属性。
将产生:
这是[一个例子](http://example.com/"标题")内联链接。(<p>这是<a href="http://example.com/"title="Title">
)
[此链接](http://example.net/)没有标题属性。(<p><a href="http://example.net/">此链接</a>没有
)
内部链接
您可以将href设置为标题,这将创建一个书签,允许您在单击后跳转到该部分。例如:
命令(在Windows上:Ctrl)+单击[此链接](#block元素)将跳转到标题“块元素”。要查看如何编写它,请移动光标或单击该链接并按下“😍”键以将元素扩展到降价源。
参考链接
引用样式链接使用第二组方括号,在其中放置您选择的标签以标识链接:
这是[一个示例][id]引用样式链接。
然后,在文档中的任何位置,您将链接标签单独定义在一行上,如下所示:
[id]:http://example.com/"可选标题在这里"
在Typora中,它们将被渲染为:
这是[一个示例][id]引用样式链接。
[id]:http://example.com/ "可选标题在这里"
隐式链接名称快捷方式允许您省略链接名称,在这种情况下,链接文本本身被用作名称。只需使用一组空方括号——例如,要将单词“谷歌”链接到google.com网站,您可以简单地写:
[谷歌][]
然后定义链接:
[谷歌]:http://google.com/
在Typora中,单击链接将展开它以进行编辑,命令+单击将在您的Web浏览器中打开超链接。
URLs
Typora允许您将URL作为链接插入,由“<”括号“>”包装。
<i@typora.io>
变为i@typora.io。
Typora还将自动链接标准URL。例如:www.google.com。
图片
图片的语法与链接类似,但它们需要在链接开始前增加一个额外的!
字符。插入图片的语法如下所示:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
您可以通过拖放从图像文件或您的网络浏览器插入图片。您可以通过点击图片来修改Markdown源代码。如果通过拖放添加的图像与您当前编辑的文档在同一目录或子目录中,则将使用相对路径。
如果您使用Markdown构建网站,您可以在YAML前言中使用属性typora-root-url为本地计算机上的图像预览指定URL前缀。例如,在YAML前言中输入typora-root-url:/User/Abner/Website/typora.io/
,然后将被视为![alt](file:///User/Abner/Website/typora.io/blog/img/test.png)。
强调
Markdown将星号()和下划线(_)视为强调的指示符。用一个或_包围的文本将被包装在HTML <em>
标签中。例如:
*single asterisks*
_single underscores_
output:
single asterisks
single underscores
粗体
双星号或双下划线将使其包围的内容被包装在HTML <strong>
标签中,例如:
**double asterisks**
__double underscores__
output:
double asterisks
double underscores
代码
要表示内联的代码段,请用反引号(`)将其包装起来。与预格式化的代码块不同,代码段表示在正常段落中的代码。例如:
Use the `printf()` function.
will produce:
Use the printf()
function.
删除线
GFM添加了创建删除线文本的语法,这在标准Markdown中是缺失的。
~~Mistaken text.~~
变成 Mistaken text.。
下划线
下划线由原始HTML支持。
<u>Underline</u>
变成Underline。
表情符号 😄
使用语法:smile:
输入表情符号。
用户可以通过按ESC键触发表情符号的自动完成建议,或者在偏好面板上启用后自动触发。此外,直接输入UTF-8表情符号字符也由菜单栏中的编辑Edit
-> Emoji & Symbols
(macOS)支持。
内联数学公式
要使用此功能,请先在偏好面板 -> Markdown标签中启用它。然后,使用$
来包装TeX命令。例如:$\lim_{x \to \infty} \exp(-x) = 0$
将被渲染为LaTeX命令。
要触发内联数学公式的内联预览:输入“$”,然后按ESC键,然后输入TeX命令。
你可以在 这里找到跟多关于内联数学公式的细节。
下标
要使用此功能,请先在偏好面板
-> Markdown
标签中启用它。然后,使用~
来包装下标内容。例如:H~2~O
, X~long\ text~
/
上标
要使用此功能,请先在偏好面板
-> Markdown
标签中启用它。然后,使用^
来包装上标内容。例如:X^2^
。
高亮
要使用此功能,请先在偏好面板
-> Markdown
标签中启用它。然后,使用==
来包装高亮内容。例如:==highlight==
。
由于文档内容较长,我将继续翻译剩余的部分。
HTML
您可以使用HTML来为纯Markdown不支持的内容设置样式。例如,使用<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>
视频
您可以使用HTML的<video>
标签来嵌入视频。例如:
<video src="xxx.mp4" />
其他HTML支持
您可以在 这里找到更多细节。