Markdown语法typora教程

严书
2023-12-01

Markdown For Typora

综述

Markdown是由Daring Fireball创造的;原始的指南在这里。但是,它的语法在不同的解析器或编辑器之间是不同的。Typora正在使用GitHub风味的Markdown。

基本构成部分

段落和断行

段落就是一个或多个连续的文本行。在markdown源代码中,段落由两个或多个空行分隔。在Typora中,您只需要一行空白(按一次回车键)来创建一个新段落。

按Shift + Return创建单个换行符。大多数其他markdown解析器将忽略单个换行符,因此,为了让其他markdown解析器识别您的换行符,您可以在行尾留下两个空格,或者插入

页眉

页眉在行首使用1-6个标签(#)字符,对应于页眉级别1-6。例如:

# This is an H1
## This is an H2
###### This is an H6

在Typora中,在标题内容后面输入“#”,然后按回车键将创建标题。

引用(用来设定一段较长的文字段落)

Markdown使用电子邮件风格的>字符进行块引用。它们表示为:

> 这是一个有两段的引用。这是第一段。
>
> 这是第二段。Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.



> 这是另一段引用。有三个空行来分隔两个引用

在Typora中,输入’ > ‘后的引用内容将生成一个引用块。Typora将为您插入适当的’ > ‘或换行符。通过添加额外的’ > '生成嵌套的块引用(一个块引号内的另一个块引号)。

列表

输入*列表项1将创建一个无序列表 - *符号可以替换为+或-。

输入 1. 列表项目1将创建一个有序的列表-他们的markdown源代码如下:

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

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

任务列表

任务列表是带有标记为 [] 或 x 的项的列表。例如:

- [ ] 任务列表项
- [ ] 列表的语法要求
- [ ] 正常的 ** 格式 ** , @mentions, #1234 refs
- [ ] 未完成的
- [x] 完成的

您可以通过单击项目前面的复选框来更改完整/不完整状态。

代码块语法高亮

Typora只在Github支持语法高亮。不支持markdown中的原始代码块。

使用代码高亮很简单:输入’ ’ '后面添加一个可选的语言标识符并按回车,我们将通过语法高亮来运行它。

这是一个例子
?```
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数学表达式。

要添加一个数学表达式,输入 并 按 ′ R e t u r n ′ 键 。 这 将 触 发 一 个 接 受 T e x / L a T e x 源 的 输 入 字 段 。 例 如 : 并按'Return'键。这将触发一个接受Tex/LaTex源的输入字段。例如: ReturnTex/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}
在 m a r k d o w n 源 文 件 中 , m a t h 块 是 由 一 对 ′ 在markdown源文件中,math块是由一对' markdownmath '标记包装的表达式:

$$
\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|Second Header| 按回车键。这将创建一个包含两列的表。

创建表之后,将焦点放在该表上将打开该表的工具栏,您可以在其中调整表的大小、对齐或删除表。您还可以使用上下文菜单复制和添加/删除单独的列/行。

下面将描述表的完整语法,但是没有必要详细了解完整的语法,因为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 |

最左边的冒号表示左对齐的列;最右边的冒号表示右对齐的列;两侧的冒号表示中间对齐的列。

脚注

你可以创建这样的脚注[^footnote].

[^footnote]: 这里是**脚注**的*文本*。

将生成:

您可以创建类似于这个脚注的脚注1

将鼠标悬停在“脚注”的上标以查看脚注的内容。

分割线

在空白行上输入***或—按回车键会画出一条水平线。


YAML Front Matter

Typora现在支持YAML Front Matter。在文章的顶部输入 —,然后按Return来引入一个元数据块。或者,您可以从Typora的顶部菜单中插入一个元数据块

目录(TOC)

输入[toc],然后按回车键。这将创建一个“目录表”部分。TOC从文档中提取所有标头,当您将其添加到文档中时,其内容将自动更新。

Span元素

Span元素将在键入后立即被解析和呈现。将光标移动到这些span元素的中间将会将这些元素展开为markdown源。下面解释每个span元素的语法。

链接

Markdown支持两种类型的链接:内联和引用。

在这两种样式中,链接文本都用[方括号]分隔。

要创建内联链接,请在链接文本的右方括号之后使用一组常规括号。在圆括号内,将URL放在您希望链接指向的位置,以及链接的可选标题,用引号括起来。例如:

这是 [an example](http://example.com/ "Title") 内联标签。

[This link](http://example.net/) 没有标题属性

会生成:

This is an example inline link. (

This is )

This link has no title attribute. (

This link has no)

内部标签

您可以将href设置为header,它将创建一个书签,允许您在单击后跳转到该部分。例如:

命令(在Windows上:Ctrl) +单击此链接将跳转到标题块元素。要查看如何写,请移动光标或点击链接?按下键将元素展开为markdown源。

参考链接

参考样式的链接使用第二组方括号,在方括号内放置您选择的标签来标识链接:

这是[一个例子][id]引用样式的链接。
然后,在文档的任何地方,像这样在一行上定义链接标签:
[id]: http://example.com/ "此处可选标题"

在Typora中,它们是这样呈现的:

这是一个示例引用样式的链接。

隐式链接名称快捷方式允许您省略链接的名称,在这种情况下,链接文本本身被用作名称。只需使用一组空白方括号—例如,要将单词“谷歌”链接到google.com网站,您只需编写:

[Google][]
然后定义链接:
[Google]: http://google.com/

在Typora中,单击链接将展开它进行编辑,command+click将打开web浏览器中的超链接。

URLs

Typora允许您将url作为链接插入,由<方括号>包装。

< i@typora.io >成为i@typora.io。

Typora还将自动链接标准url。e.g: www.google.com。

图片

图像有类似的语法链接,但他们需要一个额外的!链接开始前的char。插入图像的语法是这样的:

![Alt 文本](/路径/img.jpg)
![Alt 文本](/路径/img.jpg "可选标题")

您可以使用拖放来从图像文件或web浏览器插入图像。您可以通过单击图像来修改markdown源代码。如果使用拖放添加的图像与当前编辑的文档位于相同的目录或子目录中,则将使用相对路径。

如果你使用markdown来建立网站,你可以在你的本地计算机上使用属性typora-root-url在YAML Front Matters中为图像预览指定一个URL前缀。例如,输入typora-root-url:/User/Abner/Website/typora。[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WLdLNVQl-1582888984951)(/blog/img/test.png)]将被视为Typora中的[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-743kIWhD-1582888984952)(file:///User/Abner/Website/ Typora. io/blog/img/test.png)]。

你可以在这里找到更多的细节。

斜体

Markdown将星号( * )和下划线(_)作为强调的指标。用一个 * 或 _ 包装的文本将用HTML 标签包装。例如:

*一个星号*
_单下划线_

输出:

一个星号

单下划线

GFM将忽略单词中的下划线,它通常用于代码和名称,如下所示:

wow_great_stuff

do_this_and_do_that_and_another_thing.

若要在原本用作强调分隔符的位置生成文字星号或下划线,可以使用反斜杠转义:

\*该文本被星号包围\*

Typora建议使用*符号。

加粗

两个*或_会导致其包含的内容被一个HTML 标签包装,例如:

**两个星号**

__两个下划线__

输出:

两个星号

双下划线

Typora建议使用**符号。

行内代码

要指示代码的内联范围,请使用反引号(’)将其括起来。与预格式化的代码块不同,代码span表示正常段落中的代码。例如:

Use the `printf()` function.

会生成:

引用printf()函数。

删除线

GFM添加了语法来创建删除线文本,这是标准的Markdown中所缺少的。
~~错误文本。~~变成错误的文字。

GFM添加了语法来创建删除线文本,这是标准的Markdown中所缺少的。

~~错误文本。~~变成错误的文字。

下划线

下划线由原始 HTML 提供支持。
<u>下划线</u>成为下划线。

下划线由原始 HTML 提供支持。

下划线成为下划线。

表情符号 ??

输入带有语法的表情符号:smile:。

输入带有语法的表情符号。

用户可以通过按ESC键来触发表情符号的自动完成建议,或者在偏好面板上启用后自动触发。此外,直接输入UTF-8表情符号也可以通过在菜单栏(macOS)中编辑->表情符号和符号来支持。

内联公式

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用$包装TeX命令。例如:$\lim_{x \to \infty} \exp(-x) = 0$将被呈现为LaTeX命令。

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用 包 装 T e X 命 令 。 例 如 : 包装TeX命令。例如: TeX:\lim_{x \to \infty} \exp(-x) = 0$ 将被呈现为LaTeX命令。

要触发内联数学的内联预览:输入“$”,然后按ESC键,然后输入TeX命令。

你可以在这里找到更多的细节。

下标

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用~来包装下标内容。例如:H~2~O, X~long\ text~/

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用来包装下标内容。例如:H2~O, Xlong text/

上标

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用^来包装上标内容。例如:X^2^。

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用来包装上标内容。例如:X2^。

高亮

要使用此功能,请首先在首选项面板-> Markdown选项卡中启用它。然后,使用==来包装突出显示的内容。例如:==高亮==。

HTML

您可以使用HTML来设置纯Markdown不支持的内容的样式。例如,使用<span style="color:red">this text is red</span> 让文本改变颜色。

您可以使用HTML来设置纯Markdown不支持的内容的样式。例如,使用this text is red 让文本改变颜色。

嵌入的内容

有些网站提供基于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 src="xxx.mp4" />

其它HTML支持

你可以在这里找到更多的细节。

``Markdown

```

视频

您可以使用 HTML标签来嵌入视频。例如:

<video src="xxx.mp4" />

其它HTML支持

你可以在这里找到更多的细节。


  1. 这是脚注的正文。 ↩︎

 类似资料: