# Markdown For Typora文档(中文版) 今天下午闲来无事，又仔细看了一遍Typora里面的Markdown参考文档。顺便把它翻译成中文的md文档。在下翻译水平有限，请大家指出。有需要这个文档的md源文件的可以联系我的邮箱。 ## 概述 **Markdown**是由[Daring Fireball](http://daringfireball.net/)所创建，它最初的指引说明在[这里](http://daringfireball.net/projects/markdown/syntax)。但是，它的语法和变量在不同的解析器或者编辑器中是不同的。Typora正在使用 [GitHub Flavored Markdown][GFM]. [TOC] ## 块元素 ### 段落与换行一个段落只是一个或多个连续的文本行。在markdown源代码中，段落被两个或多个空行所分隔。在Typora中，你只需要一个空行(按一次`回车键` )去创建一个新的段落。按 `Shift` + `Return` 创建一个换行符。大多数其他markdown解析器会忽略单个换行符，所以为了让其他markdown解析器识别你的换行符，你可以在行尾留两个空格，或者插入`
`。 ### 标题标题在行首使用1-6个井号符(#)，对应标题等级1-6。例如： ```markdown # This is an H1 ## This is an H2 ###### This is an H6 ``` 在 Typora 中，输入‘#’后跟标题内容，然后按回车键将创建一个标题。它们呈现为： ### 块引用 Markdown使用电子邮件风格的 > 字符进行块引用。 ```markdown > 这是含有两个段落的块引用。这是第一段。 > > 这是第二段。因为这就是为什么它不是卡通片，它在里面，有很多生活，笑声。 >> 嵌套使用 > 这是另一个带有一段的引用。有三个空行来分隔两个块引用。 ``` 在 Typora 中，输入 ‘>’ 后跟引用内容将生成一个引用块。 Typora 会为你插入一个合适的 ‘>’ 或换行符。通过添加额外级别的“>”来嵌套块引用（另一个块引用中的块引用）。 ### 列表输入`* 列表项1` 将创建一个无序列表，`*`号可以被 `+` 或 `-` 替代输入`1. 列表项1` 将创建一个有序列表，他们的markdown源码如下: ```markdown ## 无序列表 * 红 * 绿 * 蓝 ## ordered list 1. 红 2. 绿 3. 蓝 ``` ### 任务列表任务列表是带有标记为 [ ] 或 [x]（分别代表或完成）的项目的列表。例如： ```markdown - [ ] 一个任务列表项 - [ ] 列表所需语法 - [ ] normal **formatting**, @mentions, #1234 refs - [ ] 未完成 - [x] 已完成 ``` 您可以通过点击项目前的复选框来更改已完成/未完成状态。 ### (围栏式)代码块 Typora仅支持在GitHub Flavored Markdown上的围栏代码块。原始的markdown代码块不支持。使用围栏很简单：输入\``` 然后按``回车键，在\```后面添加可选的语言标识符。我们将通过语法高亮来运行它。 ````gfm 这是一个例子 ```js function test() { console.log("notice the blank line before this function?"); } ``` 语法高亮： ```ruby require 'redcarpet' markdown = Redcarpet.new("Hello World！") puts markdown.to_html ``` ```` ### 数学块你可以使用**MathJax**来渲染*LaTex*数学表达式。输入`$$`然后按回车键去添加一个数学表达式。这将会触发一个接受*Tex/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} $$ 在markdown源文件中，数学快是一个被一对‘$$’标记包裹的*LaTex*表达式： ```markdown $$ \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} $$ ``` 你可以在[这里](https://support.typora.io/Math/)查看更多细节。 ### 表格输入`| 第一个标题 | 第二个标题 |` 并按回车键。这将创建一个包含两列的表。创建表格后，将焦点放在该表格上将为表格打开一个工具栏，您可以在其中调整大小、对齐或删除表格。您还可以使用上下文菜单复制和添加/删除单个列/行。表格的完整语法如下所述，但没有必要详细了解完整的语法，因为表格的 markdown 源代码是由 Typora 自动生成的。在 markdown 源代码中，它们看起来像： ```markdown | First Header | Second Header | | ------------- | ------------- | | Content Cell | Content Cell | | Content Cell | Content Cell | ``` 您还可以在表格中包含内联 Markdown，例如链接、粗体、斜体或删除线。最后，通过在标题行中包含冒号 (`:`)，您可以将该列中的文本定义为左对齐、右对齐或居中对齐： ```markdown | Left-Aligned | Center Aligned | Right Aligned | | :------------ |:---------------:| -----:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | ``` 最左边的冒号表示左对齐的列；最右边的冒号表示右对齐的列；两边的冒号表示居中对齐的列。 ### 脚注 ```markdown 你可以像这样创建脚注[^footnote] [^footnote]: 这是一个有**脚注**的*文本*. ``` 将会生成：你可以像这样创建脚注[^footnote] [^footnote]: 将鼠标悬停在‘脚注’上标上以查看脚注的内容。 ### 水平分割线输入`***`或者`---`在空白行上然后按回车键将会描绘一条水平线。 --- ### YAML Front Matter Typora现在支持[YAML Front Matter](http://jekyllrb.com/docs/frontmatter/)。在文章顶部输入`---`，然后按下回车键去引入一个元数据块。或者，你可以通过Typora顶部菜单插入一个元数据块。 ### 目录(TOC) 输入`[TOC]`按下回车键，将会生成一个“目录”区域。TOC从文档中提取所有标题，并在你添加到文档时自动更新其内容。 ## 行内元素行内元素将会在输入后立即解析和呈现。将光标移动到这些块元素的中间会展开这些元素的 markdown 源代码。下面是每个块元素的语法解释。 ### 链接 Markdown支持两种形式的链接：内联和参考在这两种样式中，链接文本由 [方括号] 分隔。要创建内联链接，请在链接文本的右方括号之后立即使用一组常规括号。在括号内，将 URL 放在您希望链接指向的位置，以及链接的可选标题，并用引号括起来。例如： ```markdown 这是一个示例[链接](http://example.com/ "Title") 行内链接 [该链接](http://example.net/)没有标题属性 ``` 将会生成这是一个示例[链接](http://example.com/ "Title") [该链接](http://example.net/)没有标题属性 #### 内联链接 **您可以将超链接设置为标题**，这将创建一个书签，允许您在单击后跳转到该部分。例如： Command（在 Windows 上：Ctrl）+单击 [此链接](#块元素) 将跳转到标题“块元素”。要查看如何编写，请移动光标或单击该链接并按下“⌘”键以将元素展开为markdown源代码。 #### 参考链接参考样式链接使用第二组方括号，您可以在其中放置您选择的标签来标识链接： ```markdown 这是一个 [例子][id] 参考式链接。然后，在文档中的任何位置，您可以在一行上单独定义链接标签，如下所示： [id]: http://example.com/ "Optional Title Here" ``` 在Typora中，它们将像这样呈现：这是一个 [例子][id] 参考式链接。 [id]: http://example.com/ "Optional Title Here" 隐式链接名称快捷方式允许您省略链接名称，在这种情况下，链接文本本身用作名称。只需使用一组空方括号——例如，将“Google”这个词链接到 google.com 网站，你可以简单地写： ```markdown [Google][] And then define the link: [Google]: http://google.com/ ``` 在 Typora 中，单击链接会将其展开以进行编辑，并且command+单击将在 Web 浏览器中打开超链接。 ### 网址 Typora 允许您将 URL 作为链接插入，由 `<`brackets`>` 包裹。 `` 变为。 Typora 还会自动链接标准 URL。例如：www.google.com。 ### 图像图片与链接有类似的语法，但在链接开始前需要一个额外的 `!` 字符。插入图像的语法如下所示： ```markdown ![Alt text](/path/to/img.jpg) ![Alt text](/path/to/img.jpg "Optional title") ``` 您可以使用拖放从图像文件或网络浏览器中插入图像。您可以通过单击图像来修改markdown源代码。如果使用拖放添加的图像与您当前正在编辑的文档位于同一目录或子目录中，则将使用相对路径。如果您使用 Markdown 构建网站，您可以在 YAML Front Matters 中使用属性 `typora-root-url` 为本地计算机上的图像预览指定 URL 前缀。例如，在 YAML Front Matters 中输入 `typora-root-url:/User/Abner/Website/typora.io/`，然后 `![alt](/blog/img/test.png)` 在 Typora 中将被视为 `![alt](file:///User/Abner/Website/typora.io/blog/img/test.png)` 。您可以在 [此处](https://support.typora.io/Images/) 找到更多详细信息。 ### 强调 Markdown 将星号 (`*`) 和下划线 (`_`) 视为强调的指示符。用 `*` 或 `_` 包裹的文本将用 HTML `` 标签包裹。例如： ```markdown *单个星号* _单个下划线_ ``` 输出： *单个星号* _单个下划线_ GFM 会忽略单词中的下划线，这通常用于代码和名称中，如下所示： >wow_great_stuff > >do_this_and_do_that_and_another_thing. 要在原本应被用作强调分隔符的位置生成文字意义上的星号或下划线，您可以使用反斜杠对其进行转义： ```markdown \*这写文本被文字意义上的星号所包围\* ``` Typora推荐使用*符 ### 加粗双 `*` 或 `_` 将导致其包含的内容用 HTML `` 标签包装，例如： ```markdown **双星** **双下划线** ``` 输出： **双星** **双下划线** Typora推荐使用**符 ### 代码要指示代码的行内范围，请使用反引号 (`) 将其括起来。与预先格式化的代码块不同，行内代码表示正常段落内的代码。例如： ``` markdown 使用 `printf()` 函数. ``` 将会生成： Use the `printf()` function. ### 删除线 GFM 添加了语法来创建删除线文本，这是标准 Markdown 所缺少的。 `~~错误文本。~~` ~~错误文本。~~ ### 下划线下划线由原生 HTML 提供支持。 `下划线` 下划线 ### 表情 :smile: 用语法`:smile:` 输入表情符号。用户可以通过按 "ESC "键触发表情符号的自动完成建议，或者在偏好面板上启用后自动触发。此外，直接输入UTF-8的表情符号字符也b支持，通过菜单栏的`编辑'->`表情符号'（macOS）。 ### 行内数学公式要使用这个功能，请先在 "偏好 "面板->"Markdown "标签中启用它。然后，用`$`包住一个TeX命令。例如：`$lim_{x \ to infty} `$lim_{x \ to infty} `exp(-x) = 0$. \`$exp(-x) = 0$`将被呈现为LaTeX命令。触发内联数学的内联预览：输入"$"，然后按`ESC`键，再输入一条TeX命令。你可以找到更多的细节在[这里](https://support.typora.io/Math/)。 ### 下标要使用这个功能，请先在 "偏好 "面板->"Markdown"标签中启用它。然后，使用`~`来包装下标内容。例如：`H~2~O`，`X~long text~`/。h~2~o x~long\text~ ### 上标要使用这个功能，请先在 "偏好 "面板->"Markdown "标签中启用它。然后，使用`^`来包装上标内容。例如：`X^2^`。X^2^ ### 高亮要使用这个功能，请先在 "偏好 "面板->"Markdown"标签中启用它。然后，使用`==`来包装高亮内容。例如：`==highlight==`。==highlight== ## HTML 你可以使用 HTML 来设置纯 Markdown 不支持的内容样式。例如，使用 `this text is red` 添加红色文本。 ### 嵌入内容一些网站提供基于 iframe 的嵌入代码，你也可以将其粘贴到 Typora。例如： ```markdown ``` ### 视频你可以使用 `