markdown语法

Author Avatar
sunT 3月 29, 2020
  • 在其它设备中阅读本文章

区块元素

段落和换行

一个Markdown段落是有一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的。便视为空行。比如空格和制表符都会被视为空行)。普通段落不该用空格或制表符来缩进。
有一个或多个连续的文本行组成这句话其实暗示了Markdown允许段落内的强迫换行(插入换行符),这个特性和其他大部分的text-to-HTML格式不一样。其他格式会把每个换行符都转换成<br />标签。
如果你确实想用Markdown来擦如<br />标签的话,在插入处按入俩个以上的空格然后回回车。

标题

Markdown支持两种标题的语法,类Setextatx形式。
累Setext形式是用底线的形式,利用=(最高阶标题)-(第二阶标题),例如:

This is an H1
==========
This is an H2
-------------------

任何数量的=-都是可以有效果的。
类Atx形式则是是在行首插入1个到6个#,对应到标题1到6阶,例如:

# 这是H1
##这是H2
######这是H6

你也可以选择性地闭合类atx样式的标题。这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上#,而行尾的数量也不用和行首的数量一样。

# 这是H1#
##这是H2####
######这是H6######

区块引用 Blockquotes

Markdown标记区块引用是使用类似email中用>的引用方式。如果你还熟悉在email信件中的引言部分,你就知道怎么在Markdown文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行最前面加上>

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

Markdown也允许你偷懒只在整个段落的第一行最前面加上>

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

区块医用可以嵌套,只需根据层次加上不同数量的>

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

This is the first level of quoting.

This is nested blockquote.

Back to the first level.
引用的区块内也可以使用其他的Markdown语法,包括标题,列表,代码区块等:

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

这是一个标题。

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码:

return shell_exec("echo $input | $markdown_script");

列表

Markdown支持有序列表和无需列表
无序列表使用星号和加号或是减号作为列表标记:

* Red
* Green
* Blue

效果如下:

  • Red
  • Green
  • Blue
    等同于:
+ Red
+ Green
+ Blue
- Red
- Green
- Blue

有序列表则使用数字接着一个英文句点:

1. Bird
2. McHale
3. Parish
  1. Bird
  2. McHale
  3. Parish
    很重要的一点是,你在列表标记上使用的数字并不影响输出的HTML。
    如果你表列表写成:
1. Bird
1. McHale
1. Parish
15. Bird
2. McHale
9. Parish

都是可以的。
列表项目标记通常是放在最左边,但是其实也是可以缩进,最多3个空格,项目标记后面则一定要接至少一个空格或是制表符。
列表项目可以包涵多个哦,每个项目下的段落都必须缩进4个空格或是1个制表符:

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.

效果如下:

  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 ametnisl. Aliquam semper ipsum sit amet velit.
  2. Suspendisse id sem consectetuer libero luctus adipiscing.

如果要在列表项目内放进引用,那>就需要缩进:

* A list item with a blockquote:
    > This is a blockquote
    > inside a list item.

效果如下:

  • A list item with a blockquote:

    This is a blockquote
    inside a list item.

如果要放如代码区块的话,该区块就需要缩进两次,也就是8个空格或是2个制表符:

* 一列表项包含一个列表区块:
        <代码写在这>

效果如下:

  • 一列表项包含一个列表区块:

         <代码写在这>
    

代码区块

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们不希望它以一般的方式去排版,而是原来的样子显示,Markdown会用<pre><code>标签吧代码区块抱起来
要在Markdown中家里代码区块很简单,只要简单地4个空格或是1个制表符就可以了:

这是一个普通段落:
    这是一个代码区块。

效果如下:
这是一个普通区块:

printf("Hello world!");
return 0;

一个代码块会一直持续到没有缩进的那一行(或是文件结尾)。

分割线

你可以在一行中用三个以上的星号,减号,底线来建立一个分割线,行内不能有其他东西,你也可以在星号或是建好中间插入空格。

***
* * *
*****
- - -
___________

效果如下图:






区段元素

链接

Markdown支持两种形式的链接语法:行内式参考式两种形式。
不管是哪一种,链接文字都是用[方括号]来标记。
要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入为你只链接即可,如果你还想要加上链接的title文字,只要在万只后面,用引号把title文字包起来即可。例如:

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

效果如下:
This is an example inline link.
This Link has no title attribute.
如果你是要链接到同样的主机的资源,你可以使用相对路径:

See my [About](/about/) page for details.

效果如下:
See my About page for details.

参考式的链接实在连接文字的括号后面接上另一个方括号,而在的二个方括号里面填入用以便是链接的标记:

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

接着在文件的任意处,你可以把这个标记的链接内容定义出来:

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

效果如下:
This is an example reference-style link.

链接内容定义的形式为:

  • 方括号(前面可以选择性的加上之多三个空格来缩进),里面输入链接文字
  • 接着一个冒号
  • 接着一个以上的空格或是制表符
  • 接着链接的网址
  • 选择性地接着title内容
    下面这三种链接的定义都是相同的(但是单引号已经不被支持):
[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)

链接网址也可以用方括号抱起来:

[id]:   "Optional Title Here"

你也可以把title熟悉放到下一行,也可以加一些缩进:

[id]: http://example.com/longish/path/to/resource/here
    "Optional Title Here"

链接辨识标识可以有字母,数字,空白,标点符号,但是并不区分大小写。
隐式链接标识功能:

[google][]

然后定义链接内容:

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

google

下面是一个参考式链接的范例:

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

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

强调

Markdown使用星号(*)和(_)作为标记强调字词的符号,被*或是_包围会被转成用<em>标签包围(即为斜体)。用两个包围会被转化为<strong>(即为粗体),三个的话就会变成斜粗体例如:

*Single*
**doube**
***trible***
_single_
__double__
___trible___

效果如下:
Single
doube
trible
single
double
trible
如果你的* 和_两边都有空白的话,他们会被当成普通符号处理。

代码

如果哟啊标记一小段行内代码,你可以用反引号把它包起来(` ),例如:

Use the `printf()`function.

效果:
Use the printf()function.
`foo`

图片

图片和链接相似也有两种形式来书写:行内式参考式
行内式:

![Alt Text](/path/to/img.jpg)
![Alt Text](/path/to/img.ipg "title")

效果:
Alt Text
Alt Text
详细描述如下:

  • 一个惊叹号
  • 接着一个方括号,里面放入图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号抱住加上title
    参考式:
![Alt Text][id]
[id]: url/to/image "title"

效果:
Alt Text

Markdown 还不能指定图片的长宽。如果有需要的话可以用<img>标签。

其他

自动链接

用尖括号阔气来的连接地址或是电子邮箱自动把他转化成链接:

<http://example.com/>

效果:
http://example.com/

反斜杠

用来转义。

删除线

使用要删除的文字两边左右各加两个~

~~这一行文字已经被删除了~~

效果如下:
这一行文字已经被删除了

文字高亮

在想要高亮的文字左右各加俩个=:

==文字高亮==

效果如下(如果没有做高亮就是不支持):
==高亮==

表格

a|b|c
---|-|-
1|2|3
a b
1 2