Skip to content

Latest commit

 

History

History
199 lines (167 loc) · 8.18 KB

markdown.md

File metadata and controls

199 lines (167 loc) · 8.18 KB

Markdown 语法完整使用笔记

本文档按照Markdown各种常用语法类别,以文字描述+演示的方式来展现markdown语法的使用。Markdown 的目标是实现「易读易写」,成为一种适用于网络的书写语言。HTML 是一种发布的格式,Markdown 是一种书写的格式,Markdown 的格式语法只涵盖纯文本可以涵盖的范围,Markdown 语法兼容HTML语法。

段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行。普通的Markdown 段落不可以用空格或制表符来缩进。

空行:一行之内只包含回车换行、空格、制表符。

标题

Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。

(1)类 Setext 形式

类 Setext 形式语法是使用用标题下底线的形式,包括 = (一级标题)和 - (二级标题),任何数量的 = 和 - 都可以有效果。 例如:

一级标题下加=

二级标题下加-

(2)类 atx 形式

类 Atx 形式则是在行首插入 1 到 6 个 # ,#和标题文字之间使用一个或多个空格,对应到标题 1 到 6 级, 例如:

这是 H1

这是 H2

这是 H3

这是 H4

这是 H5
这是 H6

区块引用

Markdown 标记区块引用的方法是在行的最前面加 > ,也可以只在整个段落的第一行最前面加上 >,区块引用内部可以嵌套,只要根据层次加上不同数量的 >即可,引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等。 例如:

Markdown 标记区块引用的方法是在行的最前面加> 也可以只在整个段落的第一行最前面加上 >

区块引用内部可以嵌套,只要根据层次加上不同数量的 >即可.我是内部嵌套区块,我可以使用其他Markdown 语法哦 ###我是引用区块内使用标题3语法 在引用区块内可以加入代码块 import java.net.URL; import java.util.Arrays; import java.util.Date; import java.util.Set;

列表

Markdown 支持有序列表和无序列表,无序列表使用星号、加号或是减号作为列表标记,有序列表则使用数字接着一个英文句点。两种列表方式格式都是:列表标记+空格+列表项,即列表项目标记通常是放在最左边,也可以缩进最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。

(1)无序列表

星号、加号或是减号三种列表方式效果等同。 例如:

星号列表

  • Red
  • Green
  • Blue

加号列表

  • Red
  • Green
  • Blue

减号列表

  • Red
  • Green
  • Blue

(2)有序列表

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

  1. Red
  2. Green
  3. Blue

代码块

同各种程序语言相关的写作或是标签语言原始码通常会有已经排版好的代码块,通常这些代码块我们并不希望它以一般段落的方式去排版,而是照原来的样子显示,Markdown 会用 <pre><code> 标签来把代码区块包起来。 Markdown建立代码块的方法:只要在行最前面简单地缩进 4 个空格或是 1 个制表符就可以,一个代码区块会一直持续到没有缩进的那一行。

这是一个代码区块。
只要简单地缩进 4 个空格或是 1 个制表符就可以
一个代码区块会一直持续到没有缩进的那一行

小段代码

需要引用代码时,如果引用的语句只有一段,不分行,可以用 ` 将语句包起来。 如果引用的语句为多行,可以将```置于这段代码的首行和末行。

如果引用的语句为多行,可以将```置于这段代码的首行和末行。
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.28</version>
</dependency>

分隔线

可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他内容。也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

* * *

***

*****

- - -

---------------------------------------





链接

Markdown 支持两种形式的链接语法:行内式参考式两种形式。但不管是哪一种,链接文字都是用 [方括号] 来标记。

行内式链接

行内式链接的建立可以在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如: 这是 行内式链接标题 内联方式.

参考式链接

参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记,链接辨识标签可以有字母、数字、空白和标点符号,但是并不区分大小写。

这是 [http://www.jianshu.com/u/441d207955f2][id] 参考样式风格.

也可以选择性地在两个方括号中间加上一个空格: 这是 [http://www.jianshu.com/u/441d207955f2] [id] 参考样式风格.

接着,在文件的任意处,你可以把这个标记的链接内容定义出来: [id]: http://www.jianshu.com/u/441d207955f2 "Java技术日志"

链接内容定义的形式为:

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

下面这三种链接的定义都是相同:

[feiyue]: http://www.jianshu.com/u/441d207955f2 "双引号标题"
[feiyue]: http://www.jianshu.com/u/441d207955f2 '单引号可选标题'
[feiyue]: http://www.jianshu.com/u/441d207955f2  (括号可选标题)

强调

Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被 * 或 _ 包围的字词会被转成用 <em> 标签包围,用两个 * 或 _ 包起来的话,则会被转成 <strong>例如: 单引号斜体

单下划线斜体

双引号加粗

双下划线加粗 但是如果你的 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号。如果要在文字前后直接插入普通的星号或底线,你可以用反斜线: 例如: *使用反斜线开头的*被当做是普通的字符*

图片

Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式和参考式。

行内式图片

行内式的图片语法如下: ![图片下方文字](图片相对路径或绝对路径) ![图片下方文字](图片相对路径或绝对路径 "可选标题") 详细叙述如下: 一个惊叹号 ! 接着一个方括号,里面放上图片的替代文字 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。 例如: Java技术日志

参考式图片

参考式的图片语法如下: ![图片下方文字](辨别标识id) 「id」是图片参考的名称,图片参考的定义方式则和链接参考一样: [辨别标识id]: 图片路径 "可选标题"

自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用方括号包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如: http://www.jianshu.com/u/441d207955f2

<http://example.com/>
Markdown会自动转为
<a href="http://example.com/">http://example.com/</a>

反斜杠

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 标签),你可以在星号的前面加上反斜杠: Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

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