Markdown Reference

最新推荐文章于 2022-06-03 19:01:33 发布

坠入my

最新推荐文章于 2022-06-03 19:01:33 发布

阅读量488

点赞数 1

文章标签： markdown

本文链接：https://blog.csdn.net/hsh969/article/details/104998410

版权

概述

Markdown是由Daring Fireball创建的;最初的指导原则是这里。但是，它的语法在不同的解析器或编辑器之间是不同的。Typora正在使用[GitHub调味降价][GFM]。

块元素

段落和断行

段落就是一个或多个连续的文本行。在markdown源代码中，段落由两个或多个空行分隔。在Typora中，您只需要一行空白(按一次“Return”)就可以创建一个新段落。

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

标题

页眉在行首使用1-6个散列(’ # ')字符，对应于页眉级别1-6。例如

# This is an H1

## This is an H2

###### This is an H6

在Typora中，输入“#”后面跟着标题内容，然后按“Return”键将创建标题。

引用

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

> 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。列表项目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味的藩篱。不支持markdown中的原始代码块。

使用栅栏很简单:输入\ ’ \ ’ \ ‘，然后按’回车’。在\ ’ \ ’ \ '后面添加一个可选的语言标识符，我们将通过语法高亮来运行它:

这里有一个例子:

```
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
```

Math Blocks

你可以使用MathJax渲染LaTeX数学表达式。

要添加一个数学表达式，输入’ $$ '并按’Return’键。这将触发一个接受Tex/LaTex source的输入字段。例如:

在markdown源文件中，math块是一个由一对’ $$ '标记包装的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}
$$

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

Tables

输入’ |第一个报头|第二个报头| '，然后按’回车’键。这将创建一个包含两列的表。

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

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

会产生：

You can create footnotes like this¹.

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

水平线的规则

在空白行上输入’ *** ‘或’——’，然后按’ return '将会画出一条水平线。

YAML Front Matter

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

目录(TOC)

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

Span元素

Span元素将在键入后立即被解析和呈现。将光标移动到这些span元素的中间将会将这些元素展开为markdown源。下面解释每个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设置为headers，这将创建一个书签，允许您在单击后跳转到该部分。例如:

命令(在Windows上:Ctrl) +点击这个链接将跳转到标题’块元素’。看如何写,请移动光标或点击链接“⌘”键按下元素扩展到减价来源。

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

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中，它们是这样呈现的:

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

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

[Google][]
And then define the link:

[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 text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

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

如果你使用markdown来建立网站，你可以在你的本地电脑上用属性“typora-root-url”在YAML Front Matters中为图像预览指定一个URL前缀。例如：输入 typora-root-url:/User/Abner/Website/typora.io/ in YAML Front Matters, 然后 ![alt](/blog/img/test.png) 生成 ![alt](file:///User/Abner/Website/typora.io/blog/img/test.png) in Typora.

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

强调

Markdown将星号(’ * ‘)和下划线(’ _ ')作为强调的指标。用一个“*”或“_”包装的文本将用一个HTML“”标记包装。例句:

*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建议使用“*”符号。

Strong

一个双’ * ‘或’ _ '将导致其所包含的内容被一个HTML ’ <强> '标签包装，例如:

**double asterisks**

__double underscores__

输出:

double asterisks

double underscores

Typora建议使用“**”符号。

代码

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

Use the `printf()` function.

会产生:

Use the printf() function.

加删除线

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

~~Mistaken text.~~ becomes ~~Mistaken text.~~

下划线

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

"下划线"变为下划线。

Emoji 😄

输入带有“😄”语法的表情符号。

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

内联数学

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

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

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

下标

要使用此功能，请首先在’首选项’面板-> ’ Markdown ‘选项卡启用它。然后，使用“~”来包装下标内容。例如:’ H₂O '， ’ X_{long text} ’ /

上标

要使用此功能，请首先在’首选项’面板-> ’ Markdown ‘选项卡启用它。然后，使用’ ^ '来包装上标内容。例如:“X ²”。

Highlight

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

HTML

您可以使用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支持

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

Here is the text of the footnote. ↩︎

坠入my

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
Markdown Reference

概述Markdown是由Daring Fireball创建的;最初的指导原则是这里。但是，它的语法在不同的解析器或编辑器之间是不同的。Typora正在使用[GitHub调味降价][GFM]。块元素段落和断行段落就是一个或多个连续的文本行。在markdown源代码中，段落由两个或多个空行分隔。在Typora中，您只需要一行空白(按一次“Return”)就可以创建一个新段落。按’ Shif...
复制链接

扫一扫