Markdown使用技巧

Markdown 使用技巧

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

本文介绍 Markdown 标记语言的使用方法,供学习参考,供自己查阅!


一、标题

1.使用 = 标记一级标题,使用 - 标记二级标题

//使用方法:在标题内容下方使用两个及以上标记符号且单独成行
一级标题
==
二级标题
--

实际效果:

一级标题

二级标题

2.使用 # 号标记

//使用方法:在标题内容前方加入‘#’号,并使用空格隔开, ‘#’ 号数量决定标题级别,共设六级
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

实际效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、段落

1.文本末尾添加两个及以上空格再加上换行

//使用方法:前一段落末尾添加两个及以上空格再换行来开始新的段落,此处‘_’用于模拟指示空格
第一段落__
第二段落

实际效果:

第一段落

第二段落

2.隔空行来表示重新开始一个段落

//使用方法:前一段落与新的段落之间隔一空行
第一段落

第二段落

实际效果:

第一段落

第二段落

注:Markdown 中在需要换行排版的场景中,email 式中的[区块引用](# 五、引用块)和多段落中的[列表](# 六、列表),使用更加方便灵活,且便于阅读。


三、文字效果

1.斜体字

//使用方法:将需要斜体显示的文本使用‘*’号包裹
*斜体字*

实际效果:

斜体字

2.粗体字

//使用方法:将需要粗体显示的文本使用‘**’号包裹
**粗体字**

实际效果:

粗体字

3.粗斜体字

//使用方法:将需要粗体且斜体显示的文本使用‘***’号包裹
***粗斜体字***

实际效果:

粗斜体字

4.下划线

//使用方法:将需要添加下划线的文本使用<u></u>包裹
<u>下划线</u>

实际效果:

下划线

5.删除字

//使用方法:将需要删除(划线)显示的文本使用‘~~’号包裹
~~删除字~~

实际效果:

删除字

6.高亮显示

//使用方法:将需要高亮显示的文本使用‘==’号包裹
==高亮文本==

实际效果:

高亮文本

7.上下标

//使用方法:将需要上标方式显示的文本使用‘^’号包裹,将需要下标方式显示的文本使用‘~’号包裹
上标:X^2^
下标:H~2~O

实际效果:

上标:X2
下标:H2O

8.脚注

//使用方法:编写格式为[^名称]:解释内容, 其中名称为脚注名称,前面加‘^’号,使用‘[]’括起来,其后使用‘:’,跟解释文本
这是一条脚注[^1]
[^1]:在书页正文下面或在各表下面的附注

实际效果:

这是一条脚注[1]

9.表情包

//使用方法:在需要添加表情的位置使用‘:’号包裹表情符号英文名称
这是一个笑脸:smile:
大笑:joy:
露营:tent:

实际效果:

这是一个笑脸??
大笑??
露营?

注:可使用WekFX等网站查询表情符号,也可以查看一些博主的总结。简码可能会在不同应用程序间有差异。


四、分割线

//使用方法:使用三个及以上‘*’号,或‘-’号,或‘_’号,单独成行,表示分割线
//为了兼容性,请在分割线前后均添加空白行
***
---
___

实际效果:





五、引用块

1.单个段落块引用

//使用方法:在段落前添加一个‘>’号
> 引用内容

实际效果:

引用内容

2.多个段落块引用

//使用方法:当有多个段落块引用时,在每个段落前添加一个‘>’号,段落之间的空行前也需添加一个‘>’号
> 第一段引用内容
> 
> 第二段引用内容

实际效果:

第一段引用内容

第二段引用内容

3.嵌套块引用

//使用方法:在要嵌套的段落前增加一个‘>’号
> 第一段引用内容
> 
>> 第一段中嵌套引用内容
>
> 第二段引用内容

实际效果:

第一段引用内容

第一段中嵌套引用内容

第二段引用内容


六、列表

1.有序列表

//使用方法:使用序号+‘.’作为列表标记。
1. item1
2. item2
3. item3

实际效果:

  1. item1

  2. item2

  3. item3

2.无序列表

//使用方法:使用‘*’、‘+’或‘-’作为列表标记
* item1
* item2
+ item1
+ item2
- item1
- item2

实际效果:

  • item1
  • item2
  • item1
  • item2
  • item1
  • item2

3.嵌套列表

//使用方法:将有序列表、无序列表组合使用,每次嵌套必须用四个空格缩进
-     1. itme11
      2. item12
      3. item13
-     1. item21
      2. item22

实际效果:

  • 1. itme11
    2. item12
    3. item13
    
  • 1. item21
    2. item22
    

注:如果在特殊情况下,并非意愿使用列表,(例:1997. what a great season.),即行首出现了数字+句点+空格,此时要避免产生列表,可在句点前使用反斜杠 ‘ \ ’ 。


七、链接

1.直接链接

//使用方法:使用 <> 包裹链接,简单粗暴
<www.baidu.com>

实际效果:

<www.baidu.com>

2.带标题的链接

//使用方法:形如“[标题](链接‘提示‘)”,其中,标题指显示出来的文本内容,链接即所要跳转的链接,提示指当鼠标停留在标题上时,所显示的提示信息,需要与链接之间用空格隔开
//使用‘**’将链接语法包裹起来,以示强调
跳转到[百度搜索](http://www.baidu.com "中文搜索引擎")
跳转到**[百度搜索](http://www.baidu.com "中文搜索引擎")**

实际效果:

跳转到百度搜索

跳转到百度搜索

3.引用链接

//使用方法:需要出现同一链接时使用,减少书写内容,方便统一修改
//[标题][变量] 标题指显示的文本内容,变量即可以多次引用,变量可在段落结尾或文档结尾编辑赋值
//变量的定义格式:1.放在括号中的标签,其后紧跟一个冒号和至少一个空格(例如[label]:)
//			   2.链接的URL,可以选择将其括在尖括号中
//             3.链接的可选标题,可以将其括在双引号,单引号或括号中
有个东西叫[百度][id]
[百度][id]是个搜索引擎
[id]: http://www.baidu.com "百度搜索引擎"

实际效果:

有个东西叫百度
百度是个搜索引擎

注:因不同应用程序处理URL中间空格的方式不同,若URL中出现空格,尽量使用%20代替。

4.文内跳转

//使用方法:[标题](目标标题名称) 其中标题是显示出来的文本,目标标题名称是文中出现的标题名称,需完整填写标题格式
回看[文内跳转](#4.文内跳转)

实际效果:

回看文内跳转


八、代码

1.行内代码

//使用方法:用单个‘`’号包裹所要显示的代码
打印hello代码如下`printf("hello");`

实际效果:

打印hello代码如下printf("hello");

2.代码块

//使用方法1:用‘```’包裹所要显示的代码内容,在第一行输入标记符号后,可直接输入所使用的编程语言
//使用方法2:将代码块的每一行缩进至少四个空格或一个制表符
法一:
```c++
    #include <iostream>
    int main(int argv, char* argc[])
    {
		cout << "hello world!" << endl;
    	return 0;
    }
```
法二:
    #include <iostream>
    int main(int argv, char* argc[])
    {
		cout << "hello world!" << endl;
    	return 0;
    }

实际效果:

法一:

    #include <iostream>
    int main(int argv, char* argc[])
    {
		cout << "hello world!" << endl;
    	return 0;
    }

法二:

#include <iostream>
int main(int argv, char* argc[])
{
	cout << "hello world!" << endl;
	return 0;
}

九、图片

1.本地图片

//使用方法:要添加图像,请使用感叹号‘!’, 然后在方括号增加替代文本(即当图片加载失败时显示的内容),图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本。
//形如:![图片alt](图片链接 "图片title")
![百度LOGO](/baidu.png "百度Logo")

实际效果:

Markdown使用技巧

2.网络图片

//使用方法:首先使用感叹号‘!’, 然后在方括号增加替代文本(即当图片加载失败时显示的内容),图片网络链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本。
//形如:![图片alt](图片网络链接 "图片title")
![百度LOGO](http://image1.bubuko.com/info/202108/20210816225933706815.png "百度Logo")

实际效果:

Markdown使用技巧


十、表格

//使用方法:使用‘|’号来分隔不同的单元格,使用‘-’号来分隔表头与其他行
//在表头与其他行的分隔符中,可包含对齐方式信息,具体如下:
//  ‘:-’  表示表头和内容居左对齐
//  ‘-:’  表示表头和内容居右对齐
//  ‘:-:’ 表示表头和内容居中对齐
|姓名|学号|成绩|
|:-:|-:|:-|
|张三|003|89|
|李四|009|92|

实际效果:

姓名 学号 成绩
张三 003 89
李四 009 92

以上内容整理并不充分,但应能应对大部分使用环境,高级技巧上网查询。


  1. 在书页正文下面或在各表下面的附注 ??

Markdown使用技巧

上一篇:git note


下一篇:QImage 加载Mat图像倾斜