Markdown 语法 - 第二弹


代码304 阅0 评

Markdown 语法

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。


教程开始

一、Markdown 标题

Markdown 标题有两种格式。

01.使用 = 和 - 标记一级和二级标题

写法:

我展示的是一级标题
=================
我展示的是二级标题
----------------

演示:

我展示的是一级标题

我展示的是二级标题

02.使用 # 号标记

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

写法:

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

演示:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

两种写法的一、二种效果都是一样的,推荐使用#号标记。


二、Markdown 段落格式

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。

01.字体:

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

演示:
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

02.分隔线:

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

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

演示:


    • *

    • -

无论我怎么看....都一样...

03.删除线:

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

~~AABBCCDD~~

演示:
AABBCCDD

04.下划线:

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

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

演示:

带下划线文本

05.脚注:

脚注是对文本的补充说明。
Markdown 脚注的格式如下:

[^要注明的文本]

以下实例演示了脚注的用法:

DoveのBlog
[^DoveのBlog]
[^DoveのBlog]: https://blog.sdgou.cc/

三、Markdown 列表

Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

01.无序列表:

* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项

演示:

  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项

02.有序列表:

有序列表使用数字并加上.号来表示,如:

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

演示:

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

03.列表嵌套:

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

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

演示:

  1. 第一项:

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

    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

四、Markdown 区块

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

01.区块:

> 区块引用
> 记录成长和学习

演示:

区块引用
记录成长和学习

02.嵌套区块:

另外区块是可以嵌套的,一个>符号是最外层,两个>符号是第一层嵌套,以此类推:

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

演示:

最外层

第一层嵌套

第二层嵌套

03.区块中使用列表:

区块中使用列表实例如下:

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

演示:

区块中使用列表

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

04.列表中使用区块:

如果要在列表项目内放进区块,那么就需要在>前添加四个空格的缩进。
列表中使用区块实例如下:

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

演示:

  • 第一项

菜鸟教程
学的不仅是技术更是梦想

  • 第二项

五、Markdown 代码

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

01.单个或片段代码

`printf()` 函数

演示:
printf() 函数

02.代码块

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

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

演示:

$(document).ready(function () {
    alert('JavaScript');
});

六、Markdown 链接

链接使用方法如下:

01.直接使用:

[链接名称](链接地址)
或者
<链接地址>

例如:

这是一个链接 [DoveのBlog](https://blog.sdgou.cc/)

演示:
这是一个链接 DoveのBlog

02.高级使用:

这个链接用 baidu 作为网址变量 [百度一下][baidu]
这个链接用 blog 作为网址变量 [blog][blog]
然后在文档的结尾为变量赋值(网址)


  [baidu]: https://www.baidu.com/

  [blog]: https://blog.sdgou.cc/

演示:
这个链接用 baidu 作为网址变量 百度一下
这个链接用 blog 作为网址变量 blog
然后在文档的结尾为变量赋值(网址)


七、Markdown 图片

Markdown 图片语法格式如下:

01.直接使用:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的'title'属性的文字。

使用实例:

![blog 图标](https://cdn.jsdelivr.net/gh/zhx6/imgtuchuang/4dcfe05ec68aa79f7280121ab4b6aedd.png)
![blog 图标](https://cdn.jsdelivr.net/gh/zhx6/imgtuchuang/4dcfe05ec68aa79f7280121ab4b6aedd.png "blog")

演示:

blog 图标

blog 图标

02.使用变量:

当然,你也可以像网址那样对图片网址使用变量:

这个链接用 logo 作为网址变量 [blog][logo].
然后在文档的结尾为变量赋值(网址)
[logo]: https://cdn.jsdelivr.net/gh/zhx6/imgtuchuang/4dcfe05ec68aa79f7280121ab4b6aedd.png

演示:
blog


八、Markdown 表格

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

语法格式:

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

演示:

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

对齐方式:

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

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。

实例如下:

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

演示:

左对齐右对齐居中对齐
单元格单元格单元格
单元格单元格单元格

九、Markdown 高级技巧

支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

画流程图、时序图(顺序图)、甘特图:

以下几个实例效果图如下:
1、横向流程图源码格式:

` ` `mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]
` ` `

2、竖向流程图源码格式:

` ` `mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]
` ` `

3、标准流程图源码格式:

` ` `flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
` ` `

4、标准流程图源码格式(横向):

` ` `flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
` ` `

5、UML时序图源码样例:

` ` `sequence
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?
` ` `

6、UML时序图源码复杂样例:

` ` `sequence
Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
` ` `

7、UML标准时序图样例:

` ` `mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
` ` `

8、甘特图样例:

` ` `mermaid
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
` ` `

Markdown 语法 - 第一弹

最后更新 2022-04-16
评论 ( 0 )
OωO
隐私评论