MARKDOWN指南翻译

Posted on |

[TOC]

Markdown指南翻译计划

块状元素

段落和行分割

段落是一行或连续多行组成的一段文字。在Markdown源代码中，段落被大于一行的空白行所分割。在Typora，你只需要按下 Return 键来开始一个新的段落。

按下 Shift+Return 来创建单行分割。然而大部分markdown编辑器将会忽略你的行分割，你可以在行尾加上两空格或者输入 <br/>.

标题

标题使用1-6个#字符放在开头表示1-6种不同的大小。例如：

1
2
3
# This is an H1
## This is an H2
###### This is an H6

在Typora，输入 # 后跟着标题内容，按下 Return键会自动生成相应格式的标题。

块状引用

Markdown使用电子邮件格式的 > 字符用于块状引用。如下方展示：

1
2
3
> This is a blockquote with two paragraphs. This is first paragraph.
>
> This is second paragraph.

在Typora，只需在引用前输入 > 一个块状引用会立刻生成。Typora会插入一个适当的 > 或行分割。块状引用同样允许嵌套使用。

列表

输入 *list item 1 会生成一个无序列表，* 符号同样也可以换成 + 或者 - 。
输入 1. list item 1 会生成一个有序列表，它们的 Markdown 语法如下所示：

1
2
3
4
5
6
7
8
9
## un-ordered list
* Red
* Green
* Blue

## ordered list
1. Red
2. Green
3. Blue

任务列表

任务列表是一系列标记着[]或者[x]（未完成或者完成）的列表。如下所示：

1
2
3
4
- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formatting**, @mentions, #1234 refs
- [x] completed

你可以通过点击复选框来改变完成/未完成状态。

（使用围栏）代码块

Typora只支持Github风格的Markdown代码块，原始Markdown风格的代码块不被支持。

使用代码块很方便：输入` 按下回车或者使用快捷键Ctrl+Alt
+K 。如下所示

1
2
3
4
5
6
7
8
9
10
11
12
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 数学公式.

要添加一个数学公式，输入$$$$然后按下Return。这个操作会出发一个输入域展示Tex/LaTeX 源代码。如下所示：

$V1×V2=∣∣∣∣∣∣i∂X∂u∂X∂vj∂Y∂u∂Y∂vk00∣∣∣∣∣∣V1×V2=|ijk∂X∂u∂Y∂u0∂X∂v∂Y∂v0|$

1
2
3
4
5
6
7
$$
\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}
$$

==你可以在这个网址发现更多细节。==

表格

输入 |第一标题|第二标题| 然后按 Return 键。这会产生一个两列的表格。快捷键 Ctrl+T

在表格创建以后，处于焦点的表格会弹出一个工具栏，你可以改变大小，使对齐，或者删除表格。你也可以用菜单中的项目来复制表格，添加/删除单独的列或者行。

完整的表格语法如下所示，但是没有必要知道具体细节，因为Typora会自动生成表格的markdown语法。

1
2
3
4
| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

你也可以加入内联markdown语法类似于链接，加粗，斜体或者删除线（strike through）。

最后，通过在第一行下方的线内定义格式，你可以决定文本左/中/右对齐：

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

一个左边的单冒号说明是左对齐；一个右边的单冒号说明是右对齐；两边冒号说明中间对齐。

脚注

1
2
3
You can create footnotes like this[^footnote].

[^footnote]: Here is the *text* of the **footnote**.

就像这样 ：文本脚注

分割线

输入--- 然后按 Return会显示一条分割线

YAML格式

在文章的开头输入 ---然后按下Return产生一个元数据块，另外你也可以在菜单里面找到该选项。

目录（TOC）

输入[toc] 然后按下 Return键，这回生成一个目录块，抽取文章里面所有的子标题，并且会动态更新。

行内元素

行内元素会转换并且实时渲染。将鼠标放在行内元素上，会以markdown源码的形式展现出。

超链接

markdown支持两种风格的链接：内联和引用。

两种风格的链接同时需要被[]包围。

为了创建一个内联链接，使用一对圆括号()紧跟在方括号[]后面。在圆括号内部，放入URL，同时也可以加入双引号包围的标题。如下所示：

1
2
3
This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.

This is an example in-line link.

(<p>This is <a href="http://example.com/" title="Title">)

This link](http://example.net/) has no title attribute.

(<p><a href="http://example.net/">This link</a> has no)

内部链接

你可以设置对标题进行超链接引用，会生成一个书签允许你跳转到选定的位置。

例如，按下Ctrl+点击this 会转向笔记头部

参考文献链接：

参考文献的链接使用第二种方块，在内部你可以放置一个你选择的标记去：
1
2
3
4
5
This is [an example][id] reference-style link.

Then, anywhere in the document, you define your link label like this, on a line by itself:
	
[id]: http://example.com/  "Optional Title Here"

在 Typora ，这会被渲染成这样：

这是一个 [id]: http://example.com/ “Optional Title Here”