如何快速编写Markdown、博客文档(语法收藏)

Markdown是一种轻量级标记语言,用来编写文本文档,后缀为.md。目前大部分博客文章都是支持Markdown编写。
下面介绍一个我常用的编写文档的工具:
Typora是一款轻便简洁的Markdown编辑器,支持即时渲染技术,这也是与其他Markdown编辑器最显著的区别。更重要的是它是免费的。
下载地址:Typora(https://www.typora.io/)],支持Mac,Window,Linux

基础语法

1、目录

[TOC]会自动为当前的目录生成目录,目录是根据当前文档的标题来生成

部分网站可能不支持此功能

本文效果如下:

文章目录

基础语法 1、目录 2、标题 h1 h2 h3 h4 h5 h6 3、文字修饰 4、分割线 5、列表 5.1、有序列表 5.2、无序列表 5.3、待办列表 5.4、列表嵌套 6、引用 7、代码块 8、表格 9、超链接 9.1、超链接 9.2、直接显示链接 9.3、使用描点 10、图片 10.1、插入本地图片 10.2、插入网络图片 10.3、把图片存入markdown文件 10.4、使用HTML标签 11、文字上下标 12、文字缩写 13、脚注 14、Markdown思维导图

2、标题

Markdown支持6中级别的标题,对于html表情h1-h6

# h1
## h2
### h3
#### h4
##### h5

效果如下:

h1

h2

h3

h4

h5
h6

3、文字修饰

在Markdown文档中,可以为文字添加效果:加粗,斜体,删除线,下划线,效果可叠加

*文字斜体*
**文字加粗**
***文字斜体加粗***
~~文字删除~~
~~**文字删除加粗**~~
~~*文字斜体删除*~~
<u>下划线</u>

效果如下:

文字斜体
文字加粗
文字斜体加粗
文字删除
文字删除加粗
文字斜体删除
下划线

4、分割线

分割线使用:

***
---

效果如下



5、列表

5.1、有序列表

有序列表使用 数字 和 点 表示:

1. 有序列表一
2. 有序列表二
3. 有序列表三

效果如下:

    有序列表一 有序列表二 有序列表三

5.2、无序列表

无序列表可以使用 +、-、* 表示其中任意一种都可以:

+ 无序列表1
+ 无需列表2
+ 无需列表3

- 无需列表1
- 无序列表2
- 无序列表3

* 无序列表1
* 无序列表2
* 无序列表3

效果如下

无序列表1 无需列表2 无需列表3 无需列表1 无序列表2 无序列表3 无序列表1 无序列表2 无序列表3

5.3、待办列表

待办列表可以表示任务处理状态 -[] 表示 待办 状态 , -[X] 表示 已办 状态

部分网站不支持待办列表

- [ ] 待办任务1
- [ ] 待办任务2
- [X] 已办任务	\

效果如下:

待办任务1 待办任务2 已办任务

5.4、列表嵌套

需要嵌套列表时,在子列表之前添加 四个空格 即可:

- 无需列表
    - 无序子列表1
    - 无序子列表2
1. 有序列表
    1. 有序子列表1
    2. 有序子列表2

效果如下:

无需列表 无序子列表1 无序子列表2
    有序列表
      有序子列表1 有序子列表2

6、引用

引用一端文字使用符合 >

> 这是一段引用

引用可以分为多级,一个 > 表示一级:

> 一级
>> 二级
>>> 三级
>>>> 四级
>>>>>五级

效果如下:

一级

二级

三级

四级

五级

7、代码块

Markdown支持两种代码块,一种是 行内代码块,一种是 多行代码块

行内代码块 用双反引号``(Tab键上那个键)引用,会高亮显示。

多行代码块 支持多种编程语言高亮,用三个反引号```引用

这是行内代码块`` System.out.println `` 表示方法

这是多行代码块:
```java
//java代码
```

效果如下:

这是行内代码块System.out.println 表示方法

这是多行代码块:

//java代码

8、表格

Markdown表格的书写用竖线 | 来分割不同的单元格,使用 横线 —— 来分割表头和其他行

如下表示三行三列的表格

|   表头1   |   表头2   |   表头3   | 
|    ----    |    ----    |    ----   |
| 第一行第一列 | 第一行第二列 | 第一行第三列 |
| 第二行第一列 | 第二行第二列 | 第二行第三列 |
| 第三行第一列 | 第三行第二列 | 第三行第三列 |

效果如下:

表头1 表头2 表头3
第一行第一列 第一行第二列 第一行第三列
第二行第一列 第二行第二列 第二行第三列
第三行第一列 第三行第二列 第三行第三列

使用 冒号:来表示表格中内容的 对齐方式:

冒号在左边:表示左对齐

冒号在右边:表示右对齐

两边都有冒号:表示居中对齐

|   左对齐   |   右对齐   |   居中对齐   |
|    :----    |    ----:    |    :----:   |
| 第一行第一列 | 第一行第二列 | 第一行第三列 |
| 第二行第一列 | 第二行第二列 | 第二行第三列 |
| 第三行第一列 | 第三行第二列 | 第三行第三列 |

效果如图:

左对齐 右对齐 居中对齐
第一行第一列 第一行第二列 第一行第三列
第二行第一列 第二行第二列 第二行第三列
第三行第一列 第三行第二列 第三行第三列

9、超链接

9.1、超链接

超链接表示方式如下:

[超级链接文字](网址)

使用中括号和小括号表示,文字描述写在中括号内,网址 写在小括号内,例如:

[这是百度网址](https://www.baidu.com)

效果:

这是百度网址

9.2、直接显示链接

如果想要直接显示链接地址,可以使用<>符号将地址包括:

<https:///www.baidu.com>

效果如下:

https:///www.baidu.com

9.3、使用描点

使用 描点,首先是要定义描点,然后再引用描点。

定义描点 是在一个标题后面加上{#描点名称},如下:

### 这是一个描点{#here}

然后使用如下格式使用描点,中括号内是描点描述,小括号内是描点名称

跳转到[描点](#here)

跳转到描点

10、图片

插入图片由四种方式,分别是:

10.1、插入本地图片

语法如下:

![描述图片的文字](/home/picture/test.png)

10.2、插入网络图片

语法如下:

![这是网络图片描述](http://www.baidu.com)

10.3、把图片存入markdown文件

这种方式需要首先将图片转换成base64编码格式,然后将图片内容放入markdown文档中,然后再引用图片。语法如下:

![描述图片的文字][图片声明]
[图片声明]:图片base64 编码内容

例如

![描述][base64str]
【base64str]:data:image/png;base64,..........

10.4、使用HTML标签

Markdown 中支持HTML中的标签,来显示图片,当然也可以使用HTML属性,来调节图片大小等

<image src = "">

11、文字上下标

上标使用 ,下标使用 , 如下:

下标:X<sub>2</sub>
上标:Y<sup>2</sup>

效果如下

下标:X2
上标:Y2

12、文字缩写

文字缩写使用HTML 标签,如下:

<abbr title = "Hyper Text Markup Language">HTML</abbr> 是一种标记语言

效果如下:

HTML 是一种标记语言

13、脚注

使用脚注也是分两步,一是定义注脚,二是使用注脚。

定义注脚的语法如下:

[^注脚名称]:注脚内容

中括号内有个上坚号^,后边紧跟脚注名称,中括号后边是一个冒号,在后面是脚注内容。一般脚注定义会被显示在文档的最后,多个脚注定义不能写同一行。

使用脚注时候,只要在需要脚注的文字后边加上[^脚注名称]即可,如下:

这是一个脚注实例[^脚注名称]

示例:

脚注视力[^note]
脚注示例2[^note2]

[^note]:这是脚注示例内容
[^note2]:这是脚注示例内容2

效果:

脚注视力1
脚注示例22

14、Markdown思维导图

Markmap是一个支持Markdown语法的思维导图工具,通过Markmap,可以使用markdown语法来生成思维导图。

Markmap开源免费,简单易用,你可以在这里将你写的Markdown文档转化为思维导图


    这是脚注示例内容 ↩︎

    这是脚注示例内容2 ↩︎

来源url
栏目