一文带你弄懂 markdown语法的使用

106 阅读3分钟

前言

作为一个程序员学会如何写技术文章的能力是必不可少的,这里强烈建议使用markdown 语法,Markdown是一种轻量级的标记语言,为写作提供了更优雅的写作方式,以下是我总结的一些使用方法,一篇文章教会你如何正确的方式写作。

1、标题

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推

# 我是一级标题
## 我二级标题
### 我是三级标题
#### 我是四级标题
##### 我是五级标题
###### 我是六级标题

2、段落

2.1、字体

Markdown 可以使用以下几种字体:

*倾斜字体1*
_倾斜字体2_
**加粗字体1**
__加粗字体2__
***加粗斜体***
___加粗斜体___

2.2、分隔线

三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格

***
* * *
*****
- - -
----------

2.3、删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

~~删除线~~

2.4、下划线

下划线可以通过 HTML 的 u 标签来实现:

<u>带下划线文本</u>

2.5、脚注

脚注是对文本的补充说明。

创建脚注格式类似这样 [^RUNOOB]

3、列表

Markdown 支持有序列表和无序列表。

3.1、无序列表

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项

3.2、无序列表

1. 第一项
2. 第二项
3. 第三项

3.3、列表嵌套

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

4、区块

Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

> 区块引用
> 菜鸟教程
> 学的不仅是技术更是梦想

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

* 第一项
> 菜鸟教程
> 学的不仅是技术更是梦想
* 第二项

5、代码块

代码区块使用 4 个空格或者一个制表符(Tab 键)。

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

`printf()` 函数

你也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定)

```javascript
    $(document).ready(function () {
        alert('RUNOOB');
    });
```

6、链接

链接使用方法如下:

[链接名称](链接地址)
这是一个链接 [菜鸟教程](https://www.runoob.com)

7、图片

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")

8、表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

我们可以设置表格的对齐方式:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |