Markdown语法基础

Markdown语法基础

目录

一、目录的使用

在Markdown文本中输入@[TOC](目录名称)时，编辑器会自动将各级目录生成目录

例如：

@[TOC](目录)

# 一级标题
## 二级标题

以上语法实际显示如下：

image-20230611115654708

二、标题

共支持6级标题

例如：

# 一级标题
## 二级标题
### 三级标题

以上语法实际显示如下：

image-20230611115810853

三、强调

3.1 加粗

例如：

**加粗的字**

以上语法实际显示如下：

加粗的字

3.2 键盘文本

例如：

复制文本的命令为：<kbd>ctrl</kbd> + <kbd>c</kbd>

以上语法实际显示如下：

复制文本的命令为：ctrl + c

3.3 斜体

例如：

*斜体*

以上语法实际显示如下：

斜体

3.4 行内代码

例如：

输出hello world：`print("hello world")`

以上语法实际显示如下：

输出hello world：print("hello world")

3.5 标记文本

例如：

==我是标记==

以上语法实际显示如下：

我是标记

3.6 删除文本

例如：

~~删除文本~~

以上语法实际显示如下：

删除文本

3.7 引用文本

例如：

> 引用1
> 引用2

以上语法实际显示如下：

引用1

引用2

3.8 上下标

例如：

H~2~O
2^10^

以上语法实际显示如下：

H2O

210

四、列表

4.1 有序列表

例如：

1. 项目1
	2. 项目1.1
		3. 项目1.1.1

以上语法实际显示如下：

  1. 项目1
    1. 项目1.1
      1. 项目1.1.1

4.2 无序列表

例如：

- 项目
	- 项目
		- 项目

以上语法实际显示如下：

  • 项目
    • 项目
      • 项目

4.3 检查列表

例如：

- [ ] 计划任务
- [x] 完成任务

以上语法实际显示如下：

4.4 自定义列表

第一行必须是空行，两个类别自检也需要空行
例如：


C++
: 虚构函数

Java
: 虚拟机

以上语法实际显示如下：

C++
虚构函数
Java
虚拟机

五、注脚

在需要添加注脚的词后面添加[^注脚名称]， 在文中任意位置（一般在该段落的最后）添加注脚内容[^注脚名称]: 我是注脚的具体内容，在HTML页面显示的时候，注脚内容显示在文章末尾处

例如：

在我后面添加注脚[^1]
...
...
...
[^1]: 我是注脚的具体内容

以上语法实际显示如下：

在我后面添加注脚
...
...
...

六、链接和图片

6.1 链接

例如：

[我的博客](https://www.cnblogs.com/blackimp/)

以上语法实际显示如下：

我的博客

6.2 引用类型链接

该格式在URL在Markdown中更易于显示和阅读，引用类型链接的第二部分一般放在Markdown文件的末尾处

例如：

[黑先生的博客][Blackimp]

[Blackimp]: https://www.cnblogs.com/blackimp/

以上语法实际显示如下：

黑先生的博客

6.3 图片

可以链接网络图片，也可以是本地图片，图片默认是居中，可以通过参数控制图片的大小

例如：

![美女图片](https://img-blog.csdnimg.cn/img_convert/9ae30424fa42b891bcea5e31d715199f.png#pic_center =500x600)

以上语法实际显示如下：

美女图片

七、代码片段

默认是文本格式，也可以是java、scala、python等编程语言的代码风格

例如：

```cpp
#include <iostream>
using namespace std;

int main() {
	cout << "hello world" << endl;
	
	return 0;
}
```

以上代码实际显示如下：

#include <iostream>
using namespace std;

int main() {
	cout << "hello world" << endl;
	
	return 0;
}

八、表格

8.1 创建表格

例如：

字段1 | 字段2 | 字段3
------  | ------ | ------
row1 | value1 | value2
row2 | value3 | value4
row3 | value5 | value6

以上语法实际显示如下：

字段1 字段2 字段3
row1 value1 value2
row2 value3 value4
row3 value5 value6

8.2 设置表格居左、居中、居右

例如：

字段1 | 字段2 | 字段3
:------  | :------: | ------:
居左 | 居中 | 居右
居左 | 居中 | 居右
居左 | 居中 | 居右

以上语法实际显示如下：

字段1 字段2 字段3
居左 居中 居右
居左 居中 居右
居左 居中 居右

8.3 SmartyPants

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体，和行内代码类似

例如：

类型 | ASCII | HTML
------ | ------ | ------
单引号 | `'单引号'` | '单引号'
 双引号 | `"双引号"` | "双引号"
 破折号 | `--two ---three` | --two ---three

以上语法实际显示如下：

类型 ASCII HTML
单引号 '单引号' '单引号'
双引号 "双引号" "双引号"
破折号 --two ---three --two ---three

九、注释

例如：

对后面的编程语言进行注释：C++
*[C++]: 面向对象编程语言

以上语法实际显示如下：

对后面的编程语言进行注释：C++

十、KaTeX数学公式

例如：

Gamma公式展示$\Gamma(n)=(n-1)!\quad\forall n\in\mathbb N$ 是通过欧拉积分
$$
\Gamma(z)=\int_0^\infty t^{z-1}e^{-t}dt\,.
$$

以上语法实际显示如下：

Gamma公式展示Γ(n)=(n−1)!∀n∈N 是通过欧拉积分

Γ(z)=∫0∞tz−1e−tdt.

说明：行内公式用$...$，多行公式用$$...$$，空格用\quad, 下标用_0，上标用^1, {}用于角标，\,表示 3 / 13 em space，在特殊公式后面输入常规公式记得空格

十一、甘特图

例如：

```mermaid
gantt
    dateFormat YYYY-MM-DD
    title 使用mermaid语言定制甘特图
    section 项目A
    任务一: active, des1, 2020-11-01, 2020-11-02
    任务二: crit, des2, after des1, 2d
    section 项目B
    任务三: done, des3, 2020-11-04, 3d
    任务四: des4, 5d
```

以上语法实际显示如下（红线为当前日期）：

Syntax error in textmermaid version 11.4.1

11.1 关键字

gantt：表示绘制gantt图
dateFormat：指定日期格式，YYYY-MM-DD
title：图表的名称
section：项目名称

11.2 项目任务

任务状态（默认未完成）：

  • done
  • active
  • crit

desc为任务描述，需要英文，中文会有问题

日期范围：

  • 开始日期, 结束日期（不包含）
  • 开始日期, 天数
  • after des, 天数
  • 天数（开始时间为当前日期）

十二、UML图表

12.1 使用Mermain产生一个序列图

例如：

```mermaid
sequenceDiagram
title: 使用mermaid语言定制序列图
大宝 ->> 二宝: 大宝—>>二宝
二宝 -->> 小宝: 二宝—>>小宝
小宝 -x 二宝: 二宝<—小宝
二宝 --x 大宝: 大宝<—二宝

note left of 大宝: 我是大宝
note over 二宝: 我是二宝
note right of 小宝: 我是小宝<br/>乖乖的小宝
```

以上语法实际显示如下：

小宝二宝大宝小宝二宝大宝我是大宝我是二宝我是小宝乖乖的小宝大宝—>>二宝二宝—>>小宝二宝<—小宝大宝<—二宝使用mermaid语言定制序列图

说明：

sequenceDiagram：表示汇制序列图
title：图表的名称
箭头含义：

  • ->> 实线箭头
  • –>> 虚线箭头
  • -x 带x的实线箭头
  • –x 带x的虚线箭头

note标记含义：

  • note left of xxx：位于xxx对象的左侧
  • note over xxx：覆盖在xxx对象上
  • note right of xxx：位于xxx对象的右侧

  1. 我是注脚的具体内容 ↩︎

posted @   H黑先生  阅读(76)  评论(0)  编辑  收藏  举报
（评论功能已被禁用）
相关博文：
· Markdown语法之表格-换行、合并单元格操作
· Markdown Emoji表情语法速查表
· Markdown 基础语法
· Markdown 基础语法
· Markdown 基础语法
阅读排行：
· 被坑几百块钱后，我竟然真的恢复了删除的微信聊天记录！
· 没有Manus邀请码？试试免邀请码的MGX或者开源的OpenManus吧
· 【自荐】一款简洁、开源的在线白板工具 Drawnix
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
· Docker 太简单，K8s 太复杂？w7panel 让容器管理更轻松！
点击右上角即可分享
微信分享提示