5分钟,带你迅速上手Markdown语法

avatar
奇舞团移动端团队 @奇舞团

级别: ★☆☆☆☆
标签:「通用技能」「Markdown」
作者: MrLiuQ
审校: QiShare团队


前言:本篇将重点讲解:Markdown的 “语法规范”“上手指南”


一、Markdown简介

Markdown是一种文本标记语言,它容易上手、易于学习,排版清晰明了、直观清晰。常用于撰写 “技术文档”“技术博客”“开发文档” 等等。 总之,如果你是一名开发者,并且你有写博客的欲望与想法时,使用Markdown是你不二的选择。


二、Markdown语法

接下来,我们来看一下Markdown“标准语法”

我们看下大纲,其中包括:

1、标题
  • 标准语法:使用1~6“#”符 + “空格” + “你的标题”。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题 
  • 效果图解:

注:#和「标题」之间有一个空格,这是最标准的语法格式。 有些编辑器做了兼容,有的并没有。所以最好要加上空格。

2、列表
  • 标准语法:使用-符,在文本前加入-符即可。
- 文本1
- 文本2
- 文本3

如果你希望有序,在文本前加上1. 2. 3. 4. ...

1. 文本1
2. 文本2
3. 文本3

注:-1. 2. 等和文本之间要保留一个字符的空格。

  • 效果图解:

3、超链接
  • 标准语法:[链接名](链接url)

  • 效果图解:

4、图片
  • 标准语法:
![图片名](链接url)
  • 效果图解:

5、引用
  • 标准语法:> 文本

  • 效果图解:

6、斜体、加粗
  • 标准语法 斜体*文本* 加粗**文本** 斜体&加粗***文本***

  • 效果图解:

7、代码块
  • 标准语法: ``` 你的代码 ```(前面3个点,后面3个点)

  • 效果图解:


8、表格
  • 标准语法:
dog | bird | cat
----|------|----
foo | foo  | foo
bar | bar  | bar
baz | baz  | baz
  • 效果图解:


9、特殊标记
  • 标准语法:``
`特殊样式`
  • 效果图解:


10、分割线
  • 标准语法:--- 最少3个

  • 效果图解:

11、常用html标记

注意:html标记只适合辅助使用,不一定所有编辑器都能生效。

  • 标准语法:

换行符:<br/> (或者使用Markdown标准语法:空格+空格+回车,但我感觉不是很直观)
上:<sup>文本</sup>
下:<sub>文本</sub>

  • 效果图解:


三、Markdown优点

  • 纯文本,所以兼容性极强,可以用所有文本编辑器打开。
  • 让作者更专注于写作而不是排版。(大家都是技术人员嘛..)
  • 格式转化方便,markdown文本可以很轻松转成htmlpdf等等。(图个方便嘛)
  • 语法简单
  • 可读性强,配合表格、引用、代码块等等,让读者瞬间“懂你”。

推荐文章:
Swift 5.1 (2) - 运算符
Swift 5.1(1) - 基础
iOS UI状态保存和恢复(三)
iOS UI状态保存和恢复(二)
iOS UI状态保存和恢复(一)
iOS 中精确定时的常用方法
Sign In With Apple(一)
奇舞周刊