当前位置: 首页 > news >正文

Markdown 常用语法及示例

介绍

Markdown 是一种轻量级标记语言,广泛用于编写文档、README 文件、博客文章等。本文将介绍
Markdown 的一些常用语法,帮助你快速上手。官网地址1

1. 标题

Markdown 使用井号 # 来表示标题,井号的数量决定了标题的级别,最多支持六级标题。

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

一级标题

二级标题

三级标题

四级标题
五级标题
六级标

2. 内容编辑

段落是由一个或多个连续的文本行组成,段落之间用 <br /> 或者回车,使用空格或 &nbsp; 进行缩进

这是一个段落。<br/>这是另一个段落。

一个段落。
这是另一个段落。

要在一个段落内强制换行,可以在行尾添加两个空格,然后按回车键。

这是一个段落,
强制换行。

Markdown 允许在文档中嵌入 HTML 代码。这种特性使得 Markdown 文档可以包含更复杂的格式和结构,而不仅仅是简单的文本格式化。

<font color='red'>红色文本</font>

红色文本

3. 强调

支持标记、删除线、斜体、粗体、下划线、引用多种强调方式。

标记

使用两个等于号 == 包裹文本。

==标记文本==

标记文本

删除线

使用两个波浪号 ~~ 包裹文本。

~~删除线文本~~

删除线文本

斜体

使用单个下划线 _ 包裹文本。

_斜体文本_

斜体文本

粗体

使用两个星号 ** 包裹文本。

**粗体文本**

下划线

使用两个 <ins> 标签包裹文本

<ins>下划线文本</ins>

下划线文本

粗体文本

引用

使用大于号 > 来表示引用块。

> 这是一个引用块。
>
> > 可以包含多行文本。

这是一个引用块。

可以包含多行文本。

居中文本

使用两个 <center> 标签包裹文本。

<center>居中文本</center>
居中文本

表情

使用两个冒号 : 包裹

:joy:

😂

组合使用

可以将多种组合配合使用

~~==**_组合使用_**==~~

> :warning: **Warning:** Do not push the big red button.

> :memo: **Note:** Sunrises are beautiful.

> :bulb: **Tip:** Remember to appreciate the little things in life.

组合使用

⚠️ Warning: Do not push the big red button.

📝 Note: Sunrises are beautiful.

💡 Tip: Remember to appreciate the little things in life.

4. 列表

Markdown 支持无序列表和有序列表。

无序列表

使用减号 - 开头。

- 项目一
  - 项目二
    - 子项目一
    - 子项目二
  • 项目一
    • 项目二
      • 子项目一
      • 子项目二

有序列表

使用数字加点 1. 开头。

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

任务列表

使用 - [ ] 开头,使用 x 表示已完成。

- [ ] 任务 1
- [x] 任务 2
- [ ] 任务 3
  • 任务 1
  • 任务 2
  • 任务 3

5. 注脚

详情参考[^1]
[^1]:这是详情参考注脚

详情参考2

6. 链接

使用方括号 [] 来定义链接文本,使用圆括号 () 来定义链接地址。

[Markdown 官网](https://www.markdownguide.org 'Markdown 官网')

Markdown 官网

7. 图片

Markdown 使用感叹号 ! 和方括号 [] 来定义图片替代文本,使用圆括号 () 来定义图片地址。

![替代文本](https://img0.baidu.com/it/u=1694623296,3457166421&fm=253 '图片 alt')

替代文字

8. 代码

行内代码

使用反引号`包裹行内代码。

`print("Hello, World!")`

print('hello, world!')

代码块

使用三个反引号 ` ````包裹代码块,并在第一个反引号后指定语言类型。

```java
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

9. 表格

表格语法。

| 列 1   | 列 2   | 列 3   |
| ------ | ------ | ------ |
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |
列 1列 2列 3
数据 1数据 2数据 3
数据 4数据 5数据 6

可以使用冒号 : 来对齐表格内容。

| ---左对齐--- | ---居中对齐--- | ---右对齐--- |
| :----------- | :------------: | -----------: |
| 数据 1       |     数据 2     |       数据 3 |
| 数据 4       |     数据 5     |       数据 6 |
—左对齐——居中对齐——右对齐—
数据 1数据 2数据 3
数据 4数据 5数据 6

10. 分割线

使用三个星号 * 或三个减号 - 表示

***
---


11. 数学公式

使用两个尖号 ^ 包裹表示向上,使用两个波浪号 ~ 表示向下

X^2^
H~2~O

X2
H2O

12. Markdown 画图

Mermaid 是一个用于绘制图表的 JavaScript 库,支持多种类型的图表。
许多 Markdown 编辑器和平台支持 Mermaid 语法。

  • 流程图 (Flowchart)
  • 时序图 (Sequence Diagram)
  • 甘特图 (Gantt Chart)
  • 类图 (Class Diagram)
  • 状态图 (State Diagram)
  • 饼图 (Pie Chart)
  • ER 图 (Entity Relationship Diagram)
  • 用户旅程图 (User Journey Diagram)
  • 雷达图 (Gantt Chart)

示例:

graph LR;
    A[开始] --> B[步骤1];
    B --> C[步骤2];
    C --> D[结束];
开始
步骤1
步骤2
结束

东西过多这里就不过多阐述了,更多内容参考官网1

补充

转义符号与 HTML 中的转义符号一样

Copyright (©) — &copy;
Registered trademark (®) — &reg;
Trademark (™) — &trade;
Euro (€) — &euro;
Left arrow (←) — &larr;
Up arrow (↑) — &uarr;
Right arrow (→) — &rarr;
Down arrow (↓) — &darr;
Degree (°) — &#176;
Pi (π) — &#960;

Copyright (©) — ©
Registered trademark (®) — ®
Trademark (™) — ™
Euro (€) — €
Left arrow (←) — ←
Up arrow (↑) — ↑
Right arrow (→) — →
Down arrow (↓) — ↓
Degree (°) — °
Pi (π) — π

总结

Markdown 语法简洁易读,非常适合编写各种类型的文档。通过本文介绍的常用语法,
你可以快速上手并开始使用 Markdown 来创作内容。

你可以将上述内容复制到你的 Markdown 编辑器中预览和使用。
希望这篇博客对你有帮助!如果你有任何问题或建议,欢迎在评论区留言。


  1. 官网链接 ↩︎ ↩︎

  2. 这是详情参考注脚 ↩︎

相关文章:

  • CSS中块级格式化上下文(BFC)详解
  • 【c语言初阶】函数递归
  • 玩机日记 12 在PVE Windows11上部署本地AI模型,使用群晖反代https转发到外网提供服务,配合沉浸式翻译插件翻译网页
  • 复现论文:DPStyler: Dynamic PromptStyler for Source-Free Domain Generalization
  • 蓝桥杯 Java B 组 之堆的基础(优先队列实现 Top K 问题)
  • 链表_反转链表
  • 矿用机车移动逆变电源设计(论文+源码)
  • 机器学习实战(8):降维技术——主成分分析(PCA)
  • 深入浅出:0 - 1 背包问题的滚动数组解法
  • 延迟任务的11种实现方式(下)!!
  • 机器学习实战(7):聚类算法——发现数据中的隐藏模式
  • 【C++八股】野指针和悬空指针
  • SOME/IP--协议英文原文讲解9
  • golang面试题:两个interface{} 能不能比较?
  • SprutCAMX16数控软件介绍
  • uniapp图像转换(获取本地选取或拍照的图片的base64、Blob、图像和base64的转换)
  • vscode复制到下一行
  • 什么是网络安全审计?网络安全审计的作用...
  • 【Mastering Vim 2_04】第三章:追随最佳实践:插件管理之道
  • 用PyInstaller构建动态脚本执行器:嵌入式Python解释器与模块打包 - 简明教程
  • “80后”德州市接待事务中心副主任刘巍“拟进一步使用”
  • 习近平同巴西总统卢拉会谈
  • 印称印巴军事行动总指挥同意将局势降级
  • 美国三大指数全线高开:纳指涨逾4%,大型科技股、中概股大涨
  • 从“求生”到“生活”:医保纳入创新药让梗阻性肥厚型心肌病患者重拾生活掌控权
  • “应急侠”上线,应急管理部正式发布应急科普IP形象