Markdown基本语法
前言
作为一名程序员,经常会有写技术文档的需求。Markdown由于语法简洁、使用方便深受广大程序员们的喜爱。
Markdown简介
Markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。
–摘自百度百科
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。
–摘自菜鸟教程
对于 Markdown 中未包含的标签, 可以直接使用 HTML标签,例如用 HTML <a>
标签替代 Markdown 的链接语法。
编辑器
本教程将使用 Typora 编辑器来讲解 Markdown 的语法,Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。
支持导出HTML、PDF、Word、图片等多种类型文件。
Typora 官网:https://typora.io/
2022/01/19追记
之前一直使用Typora,很喜欢它所见即所得的实时预览功能,不过现在新版收费了!最近发现了一款写作体验媲美Typora的开源神器MarkText
,支持多种主题非常炫酷,推荐给大家!
MarkText号称下一代Markdown编辑器,是一款简单易用的开源编辑器,支持Linux、MacOS和Windows系统。
它的主要特性如下:
-
和Typora一样具有无缝的实时预览功能,给您带来沉浸式写作体验;
-
支持多种不同风格的Markdown语法及扩展;
-
支持导出为Html和PDF;
-
支持三种写作模式:源码模式、打字机模式、专注模式;
-
支持多种主题:三种浅色模式、三种深色模式;
-
支持图片文件上传:支持上传到SM.MS图床和Github。
MarkText安装非常方便,仅需进入官网下载对应系统的安装包,并安装即可,下载地址:https://marktext.app/
基本语法
一、标题
(一)使用 # 号标记
示例:
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题
效果如下:
这是一级标题
这是二级标题
这是三级标题
这是四级标题
这是五级标题
这是六级标题
(二)使用 = 和 - 标记一级和二级标题
示例:
我展示的是一级标题
=================
我展示的是二级标题
-----------------
效果如下:
我展示的是一级标题
我展示的是二级标题
二、字体
Markdown 可以使用以下几种字体:
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
效果如下:
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
三、分割线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
***
* * *
*****
---
- - -
----------
效果如下:
四、删除线
~~删除线~~
效果如下:
删除线
五、 下划线
下划线可以通过 HTML 的 标签来实现:
<u>带下划线文本</u>
效果如下:
带下划线文本
六、脚注
脚注是对文本的补充说明。
Markdown 脚注的格式如下:
[^要注明的文本]
效果如下:
创建脚注格式类似这样 1。
七、列表
Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
效果如下:
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
-
第一项
-
第二项
-
第三项
有序列表使用数字并加上 . 号来表示,如:
1. 第一项
2. 第二项
3. 第三项
效果如下:
- 第一项
- 第二项
- 第三项
八、列表嵌套
列表嵌套只需在子列表中的选项前面添加四个空格即可:
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
效果如下:
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
九、区块
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
> 区块引用
> 璀若星辰
> XXX
效果如下:
区块引用
璀若星辰
XXX
另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:
> 最外层
> > 第一层嵌套
> > > 第二层嵌套
效果如下:
最外层
第一层嵌套
第二层嵌套
区块中使用列表
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项
效果如下:
区块中使用列表
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
列表中使用区块
如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。
列表中使用区块实例如下:
* 第一项
> 璀若星辰
> 列表中使用区块
* 第二项
效果如下:
- 第一项
璀若星辰
列表中使用区块 - 第二项
十、代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:
`printf()` 函数
效果如下:
printf()
函数
代码区块
用 ``` 包裹一段代码,并指定一种语言(也可以不指定):
```javascript
$(document).ready(function () {
alert('test code');
});
```
效果如下:
$(document).ready(function () {
alert('test code');
});
十一、链接
[链接名称](链接地址)
或者
<链接地址>
例如:
这是一个链接 [百度](https://www.baidu.com)
<https://www.baidu.com>
效果如下:
这是一个链接 百度
https://www.baidu.com
十二、图片
Markdown 图片语法格式如下:
![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
-
开头一个感叹号 !
-
接着一个方括号,里面放上图片的替代文字
-
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字
使用实例:
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")
效果如下:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-twPjk3B8-1637248139411)(http://static.runoob.com/images/runoob-logo.png “RUNOOB”)]
Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 标签。
使用实例:
<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">
效果如下:
十三、表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
对齐方式
我们可以设置表格的对齐方式:
- -: 设置内容和标题栏居右对齐。
- :- 设置内容和标题栏居左对齐。
- :-: 设置内容和标题栏居中对齐。
实例如下:
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| 表头 | 表头 |
| ------ | ------ |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
对齐方式
**我们可以设置表格的对齐方式:**
- **-:** 设置内容和标题栏居右对齐。
- **:-** 设置内容和标题栏居左对齐。
- **:-:** 设置内容和标题栏居中对齐。
实例如下:
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
| 左对齐 | 右对齐 | 居中对齐 |
| :----- | -----: | :------: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
我是脚注 ↩︎