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站
效果如下:
- A站
- B站
- 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
- 这是第一行列表项。
- 这是第二行列表项。
给出一些例子代码:
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中文网