blog:markdown:markdown_syntax

Markdown语法

Block Elements

标题

支持1到6级标题, 用1到6个 # 表示 

# 这是 H1

## 这是 H2

### 这是 H3

#### 这是 H4

##### 这是 H5

###### 这是 H6

block area

  • 多行，使用3个反引号
(defun hello-world () 
  (format t "hello the cruel world!") )
    cat << ABC > file
    dscdcsdcdc
    dcsdceaassec
    ABC

区块引用 Blockquotes

自己先断好行,然后在在每行的最前面加上 >

Original Text : 

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

Display Effect :

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisseid sem consectetuer libero luctus adipiscing.

也可以在整个段落的第一行最前面加上 >

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,

c

onsectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

i

d sem consectetuer libero luctus adipiscing.

区块引用可以嵌套(例如:引用内的引用)

Original Text : 

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

Display Effect :

This is the first level of quoting.
This is nested blockquote.
Back to the first level.

引用的区块内也可以使用其他的Markdown语法(包括标题，列表，代码区块)

Original Text : 

> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码：
> 
>     return shell_exec("echo $input | $markdown_script");

Display Effect :

1. 这是第一行列表项。2. 这是第二行列表项。
给出一些例子代码：
return shell_exec("echo $input | $markdown_script");

列表

Markdown支持有序列表和无序列表

  • 无序列表:

使用 星号，加号或者是减号作为列表标记, 例如：

Original Text :

  • list1
  • list2
  • list3
  + list1
  + list2
  + list3
  1. list1
  2. list2
  3. list3

Display Effect : * list1 * list2 * list3

  • list1
  • list2
  • list3
  • list1
  • list2
  • list3
  • 有序列表:

使用数字接一个英文句点, 并且在列表上使用的数字并不会影响输出的HTML结果

例如:

Original Text : 

1. May
2. June
3. July

或者 

  1. May
  1. June
  1. July

或者 

  4. May
  8. June
  2. July

上述三种写法得到的HTML都为： 

  <ol>
  <li>May</li>
  <li>June</li>
  <li>July</li>
  </ol>

Display Effect :

  1. May
  2. June
  3. July —-
  4. May
  5. June
  6. July —-
  7. May
  8. June
  9. July

列表可以包含多个段落，但是每个项目下的段落都必须缩进4个空格，或者一个制表符

  1. This is a list item with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

  2. Suspendisse id sem consectetuer libero luctus adipiscing.

Span Elements

链接

Markdown支持两种形式的链接 行内式(inline) 和 参考式(reference)

行内式

在方括号紧接着圆括号，方括号内是链接的描述，圆括号内是链接的地址, 如果想加上链接的title文字，只需在网址后面用双括号把title包括起来。 title的作用： 鼠标停在链接上，会显示title的文字

Original Text : 

This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.

Display Effect :

This is an example inline link. This link has no title attribute.

生成的HTML如下: 

<p>This is <a href="http://example.com/" title="Title">
an example</a> inline link.</p>

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

参考式

在链接文字的方括号后再接另一个方括号,在后一个方括号内填入用以辨识链接的标记

This is [an example][id] reference-style link.

然后在文中任意地方定义这个标记内容的链接地址

[id]: http://example.com/ "Optional Title Here"

链接内容定义的形式为： 

* 方括号（前面可以选择性地加上至多三个空格来缩进），里面输入链接文字
* 接着一个冒号
* 接着一个以上的空格或制表符
* 接着链接的网址
* 选择性地接着 title 内容，可以用单引号、双引号或是括弧包着

链接标签可以由字母、数字、空白和标点符号组成，但是不区分大小写

隐式链接标记功能可以让你省略定义链接标记，这种情形下，链接标记等同于链接文字 隐式链接的使用方法： 在链接文字后面加上一个空的方括号 

[Google][]

然后定义链接内容: 

[Google]: "http://google.com"

例:

Original Text : 

I get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][].

[google]: http://google.com/        "Google"
[yahoo]:  http://search.yahoo.com/  "Yahoo Search"
[msn]:    http://search.msn.com/    "MSN Search"

Display Effect :

I get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][].

参考式链接的好处是： 可读行比较好

强调

使用星号(*) 和 底线(_) 作为标记强调的符号

例如:

Original Text : 

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

Display Effect :

single asterisks single underscores double asterisks double underscores

转换为的HTML如下： 

<em>single asterisks</em>
<em>single underscores</em>
<strong>double asterisks</strong>
<strong>double underscores</strong>

## 代码

标记一小段行内代码，可以使用反引号把它包起来 ( ` )

例如：

Original Text : 

  ``Use the `printf()` function. ``

Display Effect : Use the printf() function.

生成的HTML如下： <p>Use the <code>printf()</code> function.</p>

如果要在代码区段内插入反引号，你可以用多个反引号来开启和结束代码区段：

Original Text : 

  `` ``There is a literal backtick (`) here.`` ``

Display Effect :

There is a literal backtick (`) here.

图片

在纯文字应用中设计一种 「natural」 的语法来插入图片是有一定难度的

使用和链接类似的语法来标记图片，也允许两种形式： inline 和 reference

行内式 

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

规则：

  • 一个感叹号 !
  • 一个中括号，括号内为图片的替代文字
  • 一个括号，括号内为图片的地址，还可用引号包住并加上 'title' 文字

参考式 

![Alt Text][id]

id 是图片参考的的名称,图片参考的定义方式和链接参考相同: 

[id]: url/to/image "Optionaltitle attribute"

到目前为止， Markdown 还没有办法指定图片的宽高，如果你需要的话，你可以使用普通的 <img> 标签。

其他

自动链接

Markdown支持比较简短的自动链接形式来处理网址和电子邮件地址,只要是用尖括号包起来，Markdown就会自动把它转换为链接

例如： 

<http://blog.linuxtoy.cn>

<user@linuxtoy.cn>

http://blog.linuxtoy.cn

user@linuxtoy.cn

反斜杠

makrdown可以用反斜杠来插入一些在语法有其他意义的符号

支持转义的符号：


  • 反斜线
  • ` 反引号
  • * 星号
  • _ 底线
  • {} 花括号
  • [] 方括号
  • () 括弧
  • # 井字号
  • + 加号
  • - 减号
  • . 英文句点
  • ! 惊叹号

上标与下标

直接嵌入html代码实现

H<sub>2</sub>O: 

  H<sub>2</sub>O

E = mc<sup>2</sup>: 

  E = mc<sup>2</sup>

本文来自于Markdown语法参考： Markdown/Markdown-Syntax-CN

  • blog/markdown/markdown_syntax.txt
  • 最后更改: 2022/01/09 21:43
  • 由 wikiadmin