Contents

markdown基础语法

本文为markdown官方教程基础语法篇的粗略翻译,本人水平有限,如有不足之处敬请指出。感谢观看

标题

语法部分讲解

标题部分使用#来作为标题的符号,其中一个#代表一号标题,两个代表二号,以此类推。最多只有六号标题,使用的话最多三个就足够了。
注意:标题文字和#不能紧挨着,需要使用空格隔开,要不然会失效。还有标题的前后需要使用空行,要不也实现不了效果。


# 我是一号标题

正确。

# 我是一号标题

错误,没有前后空行。


#我是一号标题

错误,#后没有空格.

其他写法

markdown的语法中给第一和第二标题给出了一种新写法。

Heading level 1
=============

Heading level 2
---------------

这种要求会低一些,不需要空格和空行

段落

段落之间用空行隔开就行,注意段落开头不要使用缩进,这可能会被识别为代码段。

换行

markdown中换行只按回车是不够的,需要在上一行的末尾加上两个以上的空格,要不然会自动拼接到一行来。可以尝试一下,下面就不举例了。 空格是看不到的,如果你的markdown支持HTML,可以在末尾加上<br>来作为换行。

文字强调

加粗

文字加粗的话可以使用**__来实现,如: I am **bold text** I am bold text
I am __bold text__ I am bold text

注意**可以和字符连着用,比如说a**bold text**a,仍然会将bold text部分识别为加粗,但是__和字符连接将识别不出来。

斜体字

斜体使用的是单个*_,用法和两个的类似,要注意使用_时不要和外部的字符连接使用。

加粗加斜体

使用三个*或者_,要注意_的使用。

(块)引用

单行引用时,另起一个段落,在那一行的开头使用>符号。若是多行引用,则另起一个段落,在这个段落的每一行的开头都加入>符号。为了兼容性,最好在引用的前后空一行

单行引用

> Dorothy followed her through many of the beautiful rooms in her castle.

效果

Dorothy followed her through many of the beautiful rooms in her castle.

多行引用

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

效果

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

嵌套引用

嵌套引用的部分再加一个>即可。

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

效果

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

引用中添加其它元素

引用中可以添加前面或者后面学到的一些东西来处理文本,比如加粗,斜体等。

列表

有序列表

在数字后加上.后跟空格即可。

1. first
2. second
3. third

效果

  1. first
  2. second
  3. third

注意:如果你想使用数字后加.但是不是为了加入序号,可以使用转义字符\。如1982\.,得到 1982.

无序列表

无序列表的使用符号有-*+,使用方法和有序的一样,不过可以嵌套使用。如:

- First item
- Second item
- Third item
    - Indented item
    - Indented item
- Fourth item
  • First item
  • Second item
  • Third item
    • Indented item
    • Indented item
  • Fourth item

注意:在同一级列表中要使用同一种符号,不可交叉使用。

在列表之间插入元素

在列表之间插入段落、引用、代码段、图片、列表等元素,但是想保持列表的连续性,可以在插入的那一段增加四个空格的缩进。(如果是使用四个空格来表示代码段的话,需要使用8个缩进)

代码(段)

标注行内代码时,使用 ` 符号,若是在代码中有 ` ,可以再外部使用两个 ` 嵌套。

标注多行代码时,代码部分使用4格缩进。或者使用 ` ` `来标注。

水平线

使用水平线需要单独起一段,使用三个或以上*-_字符。

注意:为了保证兼容性,最好是在水平线的前后各空一行。

加入链接

链接部分分为显示内容,目标地址,标题,格式如下

[content](URL)

其中,URL部分可以是链接,可以是文章中的标题
markdown不能够处理URL中的空格,所以需要使用%20来替代空格

例子

[百度](https://www.baidu.com)
[返回代码(段)](#代码(段))

百度
返回代码(段)

加入标题

在URL部分后将标题部分用双引号包裹,然后用空格区分开来,即可引入标题,其内容可在鼠标悬停在该部分内容时显现。

举例

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

My favorite search engine is Duck Duck Go.

直接使用URL或者Email

也可以直接用 < > 将URL或者Email包裹起来。

例子

<https://www.markdownguide.org>
<[email protected]>

https://www.markdownguide.org
[email protected]

引用类型的链接

引用类型分为两个部分,第一部分在正文中,使用两个中括号将内容包裹起来表示引用,另一个部分在文档中的某处(一般是最后),将这些引用的部分统一排列写出。

第一部分

第一部分很简单,形式如下

[hobbit-hole][1]
[hobbit-hole] [1]

第二部分

第二部分包含以下元素:

1. 标签,也就是序号,使用方括号包裹,后面紧跟一个分号。  
2. URL,可以用尖括号包裹起来。  
3. 可选择的标题,可以用双引号包裹,也可以使用括号包裹  

例子

[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

引用类型的链接可以将第二部分放在任何地方,比如段落后或者文章末尾。但是最终呈现的效果与前面的引用类似。

引入图片

引入图片和引入链接的方法类似,需要不同的是需要在方括号前加入!
例子

![The San Juan Mountains are beautiful!](/assets/images/san-juan-mountains.jpg "San Juan Mountains")

图片链接

让一个图片链接到另一个部分(网页或者标题),就让需要被链接的部分的标题换成图片链接即可。
例子

[![An old rock in the desert](/assets/images/shiprock.jpg "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv)

转义字符

上述使用的特殊符号,如果你想直接打出来,而不是实现其可以实现的功能,可以使用\字符将其转义。