Markdown语法总结

Markdown

Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前 github、Stackoverflow 等网站均支持这种格式。

区块元素


标题

在行首插入1至6个#,对应1到6阶标题

# 标题 H1
## 标题 H2
### 标题 H3
#### 标题 H4
##### 标题 H5
###### 标题 H6

效果如下:

标题 H1

标题 H2

标题 H3

标题 H4

标题 H5
标题 H6

还有一种是用底线的形式,添加=-来表示一阶和二阶标题

标题 H1
====
标题 H2
----

效果如下:

标题 H1

标题 H2

注意:在标题上方如果过是没有样式的纯文字的话,需要增加换行

列表

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

无序列表使用*+或是-作为列表标记:

* A站
* B站
* P站

效果如下:

  • A站
  • B站
  • P站

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

1. A站
2. B站
3. P站

效果如下:

  1. A站
  2. B站
  3. P站

列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。

区块引用

只需要在添加在整个段落的第一行最前面加上>,也可以根据层次加上不同数量的>

> Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前 github、Stackoverflow 等网站均支持这种格式。
>> 其实没什么用

效果如下:

Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前 github、Stackoverflow 等网站均支持这种格式。

其实没什么用

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

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

效果如下:

标题 H1

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

给出一些例子代码:

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

代码区块

代码区块具有高亮效果,部分markdown的显示还支持代码风格显示。使用 ```单引号中间这三个点就可以开头结束就可以显示代码块

这个没法用文本表示,只能使用图片

效果如下:

这是一个代码区块。

或者简单地缩进4个空格或是1个制表符就可以,同样对于没有样式的文本需要添加换行

效果如下:

这是一个普通段落:

这是一个代码区块。

代码区块中,一般的 Markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 Markdown 语法撰写 Markdown 语法相关的文件。

分隔线

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

* * *
***
*****
- - -
---------------------------------------

分割线效果如下:


注意:这里能使用-,如果没有和文字之间没有换行隔开会显示成二阶标题

区段元素


链接

Markdown 支持两种形式的链接语法: 行内式参考式两种形式,都是使用 [] 来标记链接文字。

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

[简书](http://jianshu.com "简书")
[微博](https://weibo.com/)

效果如下:
简书
微博

而参考式的写法则是有点像书的注解,在记链接名称的方括号后面在添加一个[],而这个[]中填写的则是对应的链接;如果不填写也可以根据链接名称写链接

为了更清楚的表现参考式的语法,使用一段文字的形式来举例,举个栗子[哔哩哔哩][1] 和 [微博][] 是最近经常上的站点。

[1]: https://www.bilibili.com/ "哔哩哔哩"
[微博]: https://weibo.com/ "微博"

效果如下:

为了更清楚的表现参考式的语法,使用一段文字的形式来举例,举个栗子哔哩哔哩微博 是最近经常上的站点。

文字样式

删除线

在文字开始和结束的位置分别添加~~

~~这是加删除线的文字~~

效果如下:
这是加删除线的文字

加粗

在文字开始和结束的位置分别添加**或者__,这是两个下划线

**这是加粗的文字**
__这是加粗的文字__

效果如下:
这是加粗的文字
这是加粗的文字

斜体

在文字开始和结束的位置分别添加*或者_

*这是倾斜的文字*

效果如下:
这是倾斜的文字

以上三种文字样式可以通过嵌套对应的语法进行叠加

~~***这是加删除线的文字***~~

效果如下:
这是加删除线的文字

代码

前面有提到代码块是使用在段落上的,代码也可以给部分文本做标记,像这样Flutter也是可以的。使用反引号`标记在需要标记的文本的开头和结尾的位置

这是`代码`行

效果如下:
这是代码

如果要在代码区段内插入反引号,就需要用多个反引号来标记开头和结尾的位置

这是`` `代码` ``行

效果如下:
这是`代码`

图片

图片在简书上就很简单,直接上传图片就可以自动生成相应的语法。

![这是图片标题](https://wx2.sinaimg.cn/mw690/89dea615gy1fj90roziyaj20g40g3gm6.jpg)

比较官方的说法是图片支持参考式的写法,但是我尝试了一下链接的参考式写法,在简书上没有办法正常显示图片,所以就没有写相应的栗子了

其他

反斜杠

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果,你可以在星号的前面加上反斜杠:

\*literal asterisks\*

效果如下:
*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

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

自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用方括号包起来

<https://www.jianshu.com/u/70bd9fefe61f>

效果如下:
https://www.jianshu.com/u/70bd9fefe61f

而我尝试过将<>去掉也是可以的显示成连接,但是我将https://www删除之后就无法直接显示了,当让加了<>依然可以显示。

表格

部分markdown的解析是可以显示表格的,这部分语法是参考马克飞象的

表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

效果如下:

表头 表头 表头
内容 内容 内容
内容 内容 内容

甚至还有Markdown解析器能够支持流程图,但是很多都支持的不是很好

参考:Markdown中文网

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • 0. 目录 0. 目录1. 斜体和粗体2. 分级标题3. 超链接3.1. 行内式3.2. 参考式3.3. 自动链接...
    跃文阅读 1,335评论 0 1
  • 0.目录(Table of Contents) 在需要目录出现的地方放置一个标记,这样会自动生成一个嵌套的包含所有...
    日居_月诸阅读 9,499评论 1 10
  • 1. 简介 首先我们需要了解什么叫Markdown。参考了很多文档,简言之,就是一种轻量级标记语言。它的优点呢,概...
    婆娘漂亮生活安逸阅读 2,168评论 0 2
  • 1. 斜体和粗体 代码示例 效果示例 这是斜体这是粗体这是斜体加粗体这是删除线 2. 分级标题 代码示例 效果示例...
    d9ead1a8ce9c阅读 330评论 0 0
  • Markdown语法总结 标签(空格分隔): 未分类 标题 列表 无序列表 列表项目标记通常是放在最左边,但是其实...
    Jerry379阅读 393评论 0 0