1. Markdown是什么?
Markdown是一种轻量级标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTML格式发布。 Markdown也可以理解为将以MARKDOWN语法编写的语言转换成HTML内容的工具。
2. 为什么要使用它?
- 它是易读(看起来舒服)、易写(语法简单)、易更改纯文本。处处体现着极简主义的影子。
- 兼容HTML,可以转换为HTML格式发布。
- 跨平台使用。
- 越来越多的网站支持Markdown。
- 更方便清晰地组织你的电子邮件。(Markdown-here, Airmail)
3. Markdown 写法资料
- github markdown使用:docs.github.com/cn/github/w…
- vitepress markdown增强:vitepress.vuejs.org/guide/markd…
- 使用vitepress记录博客,可以多看看
4. 怎么使用?
如果不算扩展,Markdown的语法绝对简单到让你爱不释手。 Markdown语法主要分为如下几大部分: 标题,段落,区块引用,代码区块,强调,列表,分割线,链接,图片,反斜杠 ****, 符号'`'。
4.1 标题
- Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。
- 类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如
- 任何数量的 = 和 - 都可以有效果。
- 类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如
一级标题
=========
二级标题
---------
效果:
一级标题
二级标题
- 类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶(常用),例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
4.2 段落
段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)。
4.3 区块引用
在段落的每行或者只在第一行使用符号>,还可使用多个嵌套引用,如:
> 区块引用
>
> > 嵌套引用
效果:
4.4 代码区块
-
代码区块的建立是在每行加上4个空格或者一个制表符(如同写代码一样)。如
- 注意:需要和普通段落之间存在空行。
这是一个普通段落:
这是一个代码区块。
效果
4.5 强调
- Markdown 在强调内容两侧分别加上
*或者_,单个包围是斜体,两个包围是加粗,如:
*斜体*,_斜体_
**粗体**,__粗体__
效果:
4.6 列表
-
无序列表
-
使用星号(*)、加号(+)、减号(-)来标记无序列表,如
- 注意:标记后面最少有一个_空格_或_制表符_。若不在引用区块中,必须和前方段落之间存在空行。
-
* 第一项
* 第二项
* 第三项
等同于
+ 第一项
+ 第二项
+ 第三项
等同于
- 第一项
- 第二项
- 第三项
效果:
-
有序列表
- 有序列表则使用数字接着一个英文句点
1. 第一项
2. 第二项
3. 第三项
效果:
4.7 分割线
- 分割线最常使用就是三个或以上
*,还可以使用-和_;你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线
* * *
***
*****
- - -
效果
---------------------------------------
4.8 链接
-
链接可以由两种形式生成:行内式和参考式。
- 不管是哪一种,链接文字都是用 [方括号] 来标记
-
行内式:
- 在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可
[胡哥的github主页](https://github.com/hjwhuge)
效果
-
参考式:
- 注意:下方的
[1]:https:://github.com/younghz/Markdown "Markdown"不出现在区块中。
- 注意:下方的
写法
[younghz的Markdown库1][1]
[younghz的Markdown库2][2]
[1]:https:://github.com/younghz/Markdown "Markdown"
[2]:https:://github.com/younghz/Markdown "Markdown"
效果:
4.9 图片
-
添加图片的形式和链接相似,只需在链接的基础上前方加一个
!。- 一个惊叹号 !
- 接着一个方括号,里面放上图片的替代文字
- 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。


4.10 反斜杠``
-
相当于反转义作用。使符号成为普通符号。
- 例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 `` 标签),你可以在星号的前面加上反斜杠
*literal asterisks*
4.11 符号'`'
- 起到标记作用。如:
`ctrl+a`
效果
5. 谁在用?
Markdown的使用者:
- GitHub
- 简书
- Stack Overflow
- Apollo
- Moodle
- 等等
6. 尝试一下
- Chrome下的插件诸如
stackedit与markdown-here等非常方便,也不用担心平台受限。 - 在线的dillinger.io评价也不错
- Windowns下的MarkdownPad也用过,不过免费版的体验不是很好。
- Mac下的Mou是国人贡献的,口碑很好。
- Linux下的ReText不错。
当然,最终境界永远都是笔下是语法,心中格式化 :)。
注意:不同的Markdown解释器或工具对相应语法(扩展语法)的解释效果不尽相同,具体可参见工具的使用说明。 虽然有人想出面搞一个所谓的标准化的Markdown,[没想到还惹怒了健在的创始人John Gruber] (blog.codinghorror.com/standard-ma… )。
以上基本是所有traditonal markdown的语法。
其它:
列表的使用(非traditonal markdown): 用|表示表格纵向边界,表头和表内容用-隔开,并可用:进行对齐设置,两边都有:则表示居中,若不加:则默认左对齐。
| 代码库 | 链接 |
|---|---|
| MarkDown | github.com/younghz/Mar… |
| MarkDownCopy | github.com/younghz/Mar… |
关于其它扩展语法可参见具体工具的使用说明。