十分钟学会Markdown,让你的文稿瞬间增色

在这里插入图片描述

欢迎点赞 收藏 ⭐留言 如有错误敬请指正!

Markdown是一种轻量级的标记语言,它的目标是通过易读易写的纯文本格式来实现文档的书写。使用Markdown,目标是让人们尽可能轻松地编写文档,并让这些文档轻松地转换成有效的HTML(或其他格式)。

目录

  • 一、基本语法
    • 1.1 标题
    • *1.2强调*
    • 1.3 列表
    • 1.4 代码块
    • 1.5 链接
    • 1.6 图片
    • 1.7 目录
  • 二、扩展语法
    • 2.1 表格
    • 2.2 代码高亮
    • 2.3 删除线
    • 2.4 水平分割线
    • 2.5 脚注
    • 2.6 数学公式
    • 2.7 流程图
    • 2.8 时序图
    • 2.9 甘特图
    • 2.10 类图
    • 2.11 状态图
    • 2.12 自定义标题id
    • 2.13 自定义标题锚点链接
    • 2.14 容器
    • 2.15 Mermaid.js
  • 三、Markdown语法所有常用的快捷键和对应的功能
  • 四、总结

一、基本语法

1.1 标题

在文本前加上#,表示这是一级标题,#越多,标题级别越低,最多到六级标题,如下所示:

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

1.2强调

可以使用下划线或星号对文本进行强调,单个下划线或星号表示斜体,两个下划线或星号表示加粗。

*斜体*
_斜体_

**加粗**
__加粗__

1.3 列表

有两种列表,无序列表和有序列表。

无序列表使用*或-符号表示,有序列表使用数字加英文句点表示。列表的每项要顶格书写。

> 这是一段引用。
>> 这是一个嵌套的引用。

1.4 代码块

使用三个反引号```将代码块包含起来,可以指定语言,使代码更易读。

​```python
这是python代码
print("Hello, world!")
​```

1.5 链接

链接的格式为链接显示文本,可以将链接显示文本省去,使用链接地址作为链接显示文本。

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

1.6 图片

插入图片的格式为!图片显示文本,与链接很类似,只是在前面加了一个感叹号。

[外链图片转存失败,源站可能有防盗图片保存下来直接1](http://www上传gexample-coPna5e.p(http://www.example.com/image.png)]

1.7 目录

插入图片的格式为!图片显示文本,与链接很类似,只是在前面加了一个感叹号。

@[TOC](这里写目录标题)
# 一级目录
## 二级目录
### 三级目录

二、扩展语法

2.1 表格

使用-表示跨列,|表示跨行,如下所示:

|  表头1  |  表头2  |  表头3  |
| --- | --- | --- |
|  数据1  |  数据2  |  数据3  |
|  数据4  |  数据5  |  数据6  |

2.2 代码高亮

使用三个反引号```指定代码的语言,使代码有不同的高亮颜色。

​```python
这是python代码
print("Hello, world!")
​```

2.3 删除线

使用两个波浪线表示删除线。

~~这是一段已经被删除了的文本。~~

2.4 水平分割线

使用三个或更多的星号、减号或下划线表示水平线。

---
***
___

2.5 脚注

使用脚注可以在文章中提供注释解释或者参考文献,使用[^标识符]表示脚注,脚注的实际内容在文章底部显示。

这是一段有脚注[^1]的文本。

[^1]: 这是脚注内容。

2.6 数学公式

  1. 内嵌公式
    行内公式:将公式用一对 包裹(例如: 包裹(例如: 包裹(例如:f(x) = x^2 )独立公式:将公式用一对 ) 独立公式:将公式用一对 )独立公式:将公式用一对 包裹(例如: 包裹(例如: 包裹(例如: f ( x ) = x 2 f(x) = x^2 f(x)=x2$)
  2. 特殊符号:可以使用反斜杠\加特殊符号的名称或代码进行输入(例如:\alpha 或者 ★)

使用Markdown语法创建数学公式目录的示例:

## Markdown语法目录-数学公式

1. 内嵌公式
   - 行内公式(例如:$f(x) = x^2$)
   - 独立公式(例如:$$f(x) = x^2$$)
2. 特殊符号
   - 希腊字母(例如:$\alpha$、 $\beta$、 $\gamma$)
   - 求和、积分符号(例如: $\sum_{i=1}^{n} i = \frac{n(n+1)}{2}$, $\int_{a}^{b} f(x) dx$)
   - 物理量符号(例如: $\hbar,\omega,\sigma,\mu$)
   - 其他符号(例如: $\infty,\alpha+\beta,\alpha\cdot\beta,\alpha\subseteq\beta$)

2.7 流程图

Markdown语法目录-插入Mermaid流程图

1. 流程图
   ```mermaid
   graph TD;
     A-->B;
     A-->C;
     B-->D;
     C-->D;

2.8 时序图

Markdown语法目录-插入Mermaid时序图

sequenceDiagram;
  A->>B: 请求数据;
  B->>C: 处理数据;
  C->>D: 返回相应;

2.9 甘特图

Markdown语法目录-插入Mermaid甘特图

gantt
    title 甘特图
    dateFormat  YYYY-MM-DD
    section Section
    完成任务       :done,    des1, 2021-05-01,2021-05-08
    未完成任务     :active,  des2, 2021-05-11, 6d
    未完成任务     :         des3, after des2, 6d

2.10 类图

Markdown语法目录-插入Mermaid类图

classDiagram
  Animal <|-- Duck
  Animal <|-- Fish
  Animal <|-- Zebra
  Animal : +int age
  Animal : +String gender
  Animal: +isMammal()
  Duck   : +swim()
  Fish   : +swim()
  Zebra  : +run()

2.11 状态图

Markdown语法目录-插入Mermaid状态图

stateDiagram-v2
  [*] --> Off
  Off --> On : 电源开关
  On --> OvertempAlarm : 温度过高
  On --> [*] : 关闭
  OvertempAlarm --> [*] : 关闭

2.12 自定义标题id

在标题文本后添加 {#custom-id} 来为标题添加ID。这将在渲染的HTML中生成一个id属性,方便您在其他部分引用该部分。

# 这是一个一级标题 {#custom-id}

2.13 自定义标题锚点链接

使用Markdown的默认标题锚点链接可能不太适合您的需求。在标题文本后添加 {: #custom-id } 来自定义锚点链接。

# 这是一个一级标题 {: #custom-id }

2.14 容器

使用三个大于号(>>>)表示一个容器块。可以将更多的Markdown语法嵌入其中,来制作更复杂的组件。

>>>

# 这是一个标题

这是一段正文。

---

- 这是一个列表项
- 这是另一个列表项

>>>

2.15 Mermaid.js

Mermaid.js是一个流程图、状态图和时序图的绘图工具。您可以使用Markdown语言来编写它们。只需要在代码块里添加mermaid以及您想要绘制的图表。

```mermaid
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

三、Markdown语法所有常用的快捷键和对应的功能

快捷键 功能
Ctrl+B 选中文本,加粗文本
Ctrl+I 选中文本,斜体显示
Ctrl+U 选中文本,添加下划线
Alt+Shift+5 选中文本,添加删除线
Ctrl+5 选中文本,添加代码块
Alt+Shift+0 添加无序列表
Alt+Shift+1 添加一级标题
Alt+Shift+2 添加二级标题
Alt+Shift+3 添加三级标题
Alt+Shift+4 添加四级标题
Alt+Shift+5 添加五级标题
Alt+Shift+6 添加六级标题
Alt+Shift+9 添加有序列表
Ctrl+` 添加行内代码
Ctrl+K 添加链接
Ctrl+Shift+I 添加图片
Ctrl+Shift+M 插入数学公式
Ctrl+Shift+X 添加删除线(Mac)
Ctrl+Shift+D 复制当前行或选中区域,同时在光标下方插入复制内容(Windows)
Ctrl+T 表格
Ctrl+L 插入连接(Windows)

四、总结

通过 Markdown 语法的学习,大家能够更顺畅地写作,并且不用担心排版的问题。而 Markdown 的语法非常简洁明了,也不需要任何工具,只需要在编辑器里面打字即可。Markdown 可以转化为多种格式,如 HTML、PDF、PPT 等,所以使用它是一种非常方便的方式来写作并且分享信息。

你可能感兴趣的:(前端,java,编辑器,windows,标记语言,博客工具,文本编辑器)