Markdown文档语法

认识Markdown

Markdown是一种轻量级标记语言,具有纯文本格式语法,通过简单标记语法,使普通文本内容具有一定格式。他可以转换为许多输出格式,常见的HTML/PDF/WORD等。当然Markdown也有一定的局限性,比如设置字体颜色和图片大小,不过我们可以通过html标签去实现。

一、标题

  • 常规标题:使用#号可表示 1-6 级标题,一级标题对应一个#号,二级标题对应两个#号,以此类推。(注:#和标题文字间需要用空格隔开
// 示例
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果如下:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、字体

  • 加粗:要加粗的文字左右分别用2个*号包起来
  • 斜体:要倾斜的文字左右分别用1个*号包起来
  • 斜体加粗:要倾斜和加粗的文字左右分别用3个*号包起来
  • 删除线:要加删除线的文字左右分别用两个~~号包起来
// 示例
**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

效果如下: 这是加粗的文字 这是倾斜的文字 这是斜体加粗的文字 这是加删除线的文字

三、区块

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

效果如下:

区块引用

  • 区块嵌套:一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推
// 示例
> 最外层
> > 第一层嵌套
> > > 第二层嵌套

效果如下:

最外层

第一层嵌套

第二层嵌套

4、图片

// 语法
![图片alt](图片地址 '图片标题(可选)')

// 示例
![动漫图片](https://img2.baidu.com/it/u=2421090168,324781765&fm=253&app=138&size=w931&n=0&f=JPEG&fmt=auto?sec=1677690000&t=4e6e4f1a0b230b2b2e9aa7d714a31b97 '动漫图片标题')

效果如下:

5、链接

// 语法
[超链文本内容](超链接地址 "超链接title")

// 示例
[百度](http://baidu.com)

效果如下: 百度

6、列表

  • 无序列表:无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格
// 示例
* 第一项
+ 第一项
- 第一项

效果如下:

  • 第一项
  • 第一项
  • 第一项

  • 有序列表:使用数字并加上 . 号来表示,这些标记后面要添加一个空格

// 示例
1. 第一项
2. 第二项
3. 第三项

效果如下:

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

  4. 列表嵌套:列表嵌套只需在子列表中的选项前面添加四个空格即可

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

效果如下:

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

7、表格

// 语法
表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略

// 示例
表头|表头|表头
--|:--:|--:
单元格|单元格|单元格
单元格|单元格|单元格
单元格|单元格|单元格

效果如下:

表头 表头 表头
单元格 单元格 单元格
单元格 单元格 单元格
单元格 单元格 单元格

8、代码

  • 单行代码:果是段落上的一个函数或片段的代码可以用反引号把它包起来(`)
// 示例
Javascript开发中我们可以通过`console.log()`在控制台中输出内容

效果如下: Javascript开发中我们可以通过console.log()在控制台中输出内容

  • 整段代码:可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定)
$(document).ready(function () {
alert('Hello World');
});
Copyright © 高笑石 (2021 - present) all right reserved,powered by Gitbook文件修订时间: 2023-02-28 18:10:26

results matching ""

    No results matching ""