Markdown语法入门说明
一、Markdown
语法是什么?
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
Markdown
的目标是实现「易读易写」。
可读性,无论如何,都是最重要的。一份使用Markdown
格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。
Markdown
语法的目标是:成为一种适用于网络的书写语言。
二、Markdown
语法用途
用于编写说明文档和博客,并且以“README.MD”的文件名保存在软件的目录下面。
除此之外,现在由于我们有了RStudio
这样的神级编辑器,我们还可以快速将Markdown
转化为演讲PPT
、Word产品文档
、LaTex论文
甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown
已经被确立为科学研究规范,极大地推进了动态可重复性研究的历史进程。
三、Markdown
语法常用格式
区块元素
标题
类 Setext 形式是用底线的形式,利用 =
(最高阶标题)和 -
(第二阶标题)
例如:
This is an H1
=============
和
This is an H2
-------------
类 Atx 形式则是在行首插入 1 到 6 个 #
,对应到标题 1 到 6 阶
例如:
# 这是 H1
## 这是 H2
###### 这是 H6
区块引用
Markdown
标记区块引用是使用类似 email 中用 >
的引用方式。如果你还熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown
文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行的最前面加上 >
就行了
例如:
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
Markdown
当然也允许你偷懒只在整个段落的第一行最前面加上 >
就可以
例如:
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> 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.
>
```
>引用的区块内也可以使用其他的 `Markdown` 语法,包括标题、列表、代码区块等
例如:
这是一个标题。
- 这是第一行列表项。
- 这是第二行列表项。
列表
Markdown
支持有序列表和无序列表。
无序列表
使用 *
、+
或 -
作为列表标记
例如:
* Red
* Green
* Blue
等同于
+ Red
+ Green
+ Blue
等同于
- Red
- Green
- Blue
有序列表
则使用数字接着一个英文句点 (很重要的一点是,你在列表标记上使用的数字并不会影响输出的 HTML 结果)
例如:
1. Bird
2. McHale
3. Parish
列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符
例如:
1. This is a list item with two paragraphs. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus.
2. Suspendisse id sem consectetuer libero luctus adipiscing.
例如:
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
如果要放代码区块
的话,该区块就需要缩进两次
,也就是 8 个空格
或是 2 个制表符
例如:
* 一列表项包含一个列表区块:
<这是代码>
代码区块
和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown
会用 <pre>
和 <code>
标签来把代码区块包起来。
要在 Markdown
中建立代码区块
很简单,只要简单地缩进 4 个空格
或是 1 个制表符
就可以了
例如:
这是一个普通段落:
这是一个代码区块.
在代码区块里面, &
、 <
和 >
会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown
插入范例用的 HTML 原始码,只需要复制贴上,再加上缩进就可以了,剩下的 Markdown
都会帮你处理
代码区块中,一般的 Markdown
语法不会被转换,像是星号
便只是星号
分割线
你可以在一行中用三个以上的 *
、 -
、_
来建立一个分隔线,行内不能有其他东西。你也可以在星号
或是减号
中间插入空格
以下每种写法都可以建立分割线:
* * *
***
*****
- - -
——————————————————————
强调
Markdown 使用星号 *
和底线 _
作为标记强调字词的符号,被 *
或 _
包围的字词会被转成用 <em>
标签包围,用两个 *
或 _
包起来的话,则会被转成 <strong>
标签
例如:
* single asterisks *
_ single underscores _
** double asterisks **
__ double underscores __
转译为
<em> single asterisks </em>
<em> single underscores </em>
<strong> double asterisks </strong>
<strong> double underscores </strong>
你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调
也可以直接插在文字中间,但是如果你的 *
和 _
两边都有空白
的话,它们就只会被当成普通的符号
其他
自动链接
Markdown
支持以比较简短的自动链接形式来处理网址
和电子邮件信箱
,只要是用尖括号
包起来, Markdown
就会自动把它转成链接。一般网址的链接文字就和链接地址一样。
反斜杠
Markdown
可以利用反斜杠来插入一些在语法中有其它意义的符号。
例如:想要用星号加在文字旁边的方式来做出强调效果(但不用 <em> 标签)
\* literal asterisks \*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
四、总结
以上介绍的是比较常用的 Markdown
语法,还并不完善,不过对于平时只是写个文档的小伙伴来说已经够用了哦。