Markdown基本语法与高级特性教程:编写格式丰富文档的必备指南

2025-01-10 16:29 更新

Markdown是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML。以下是Markdown的一些基本语法和示例:

标题

使用#来表示标题。一个#表示最大的标题(相当于HTML的<h1>),六个#表示最小的标题(相当于HTML的<h6>)。

  1. ## 最大标题
  2. ## 次级标题
  3. ### 第三级标题
  4. ... 以此类推
  5. ###### 最小标题

强调

使用*_来强调文本。

  1. *这段文字会显示为斜体*
  2. _这段文字也会显示为斜体_
  3. **这段文字会显示为粗体**
  4. __这段文字也会显示为粗体**
  5. ~~这段文字会显示为删除线~~

列表

使用-, +, 或 *创建无序列表。

  1. - 列表项一
  2. - 列表项二
  3. - 子列表项一
  4. - 子列表项二
  5. + 第二个列表项
  6. * 第三个列表项

有序列表使用数字后跟点来创建:

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

链接

使用[]()来创建链接。

  1. [点击这里访问Google](https://www.google.com)

图片

使用![]()来插入图片。

  1. ![替代文本](https://www.example.com/image.jpg "可选的标题")

代码

使用反引号来标记代码。

  1. `alert("Hello World!");`

对于代码块,使用三个反引号:

  1. ```javascript
  2. function example() {
  3. console.log("这是一个代码块示例");
  4. }

引用

使用>来创建引用。

  1. > 这是一段引用文本
  2. > 可以包含多行
  3. >
  4. > 第二段引用文本

表格

使用|---来创建表格。

  1. | 标题1 | 标题2 | 标题3 |
  2. |-------|-------|-------|
  3. | 单元格1 | 单元格2 | 单元格3 |
  4. | 单元格4 | 单元格5 | 单元格6 |

任务列表

使用- [ ]- [x]来创建任务列表。

  1. - [ ] 未完成的任务
  2. - [x] 已完成的任务

转义字符

使用反斜杠\来转义Markdown中的特殊字符。

  1. \*这不是斜体\*

分隔线

使用三个或更多的*, ---___来创建分隔线。

  1. ---
  2. 或者
  3. ***
  4. ---

这些是Markdown的一些基本语法。使用这些语法可以创建格式丰富的文档,并且它们可以很容易地被转换成HTML格式。

除了基本语法,Markdown的功能远不止于此。以下是一些更高级的Markdown特性和示例,掌握这些特性和用法,让你的文档一直编写一直爽。

内联HTML

Markdown支持内联HTML,这意味着你可以在Markdown文档中直接使用HTML标签。

  1. <div>这是一个div元素</div>
  2. <span>这是一个span元素</span>

块引用

块引用可以用于创建引用块,通常用于引用文本或代码。

  1. > 这是一个引用块。
  2. >
  3. > 你可以在引用块中使用Markdown语法,包括标题、列表等。

链接和图片的标题

链接和图片可以包含一个可选的标题作为工具提示。

  1. [这是一个链接](https://www.example.com "链接标题")
  2. ![这是一张图片](https://www.example.com/image.jpg "图片标题")

脚注

一些Markdown解析器支持脚注,尽管这不是标准的Markdown语法。

  1. 这是一个脚注的例子[^1]
  2. [^1]: 这是脚注的内容。

折叠内容

一些Markdown编辑器支持折叠内容,允许你隐藏或展开部分文本。

  1. <details>
  2. <summary>点击展开/折叠</summary>
  3. 这里是可以被折叠的内容...
  4. </details>

表格扩展语法

一些Markdown解析器支持更复杂的表格语法,包括对齐和分隔行。

  1. | 左对齐 | 居中 | 右对齐 |
  2. | :------ | :---: | ------: |
  3. | 单元格 | 单元格 | 单元格 |
  4. | 单元格 | 单元格 | 单元格 |

定义列表

定义列表在标准的Markdown中不被支持,但在一些变体中可以使用。

  1. 项目1
  2. : 定义1
  3. 项目2
  4. : 定义2

流程图和序列图

一些Markdown解析器支持Mermaid语法,可以创建流程图和序列图。

  1. ```mermaid
  2. graph LR
  3. A[开始] --> B{决策}
  4. B -- 是 --> C[结果1]
  5. B -- 否 --> D[结果2]

  1. ## 标记和删除线
  2. 在一些Markdown解析器中,你可以使用`==``~~`来标记文本或删除线文本。
  3. ```markdown
  4. 这里是==标记的文本==
  5. 这里是~~删除线的文本~~

高亮

一些Markdown编辑器支持文本高亮。

  1. ==这段文本将被高亮==

行内属性(如字体大小和颜色)

一些Markdown解析器支持行内属性,如改变字体大小或颜色。

  1. *小型***中型*****大型***
  2. ~~红色文本~~{: .red}

V 哥提醒需要注意哦,并非所有的Markdown解析器都支持上述所有特性,特别是那些非标准的扩展特性。在使用时,你需要确认你的Markdown解析器或编辑器是否支持这些特性。

好了,以上这些特性,觉对可以满足你编写Markdown(md)的需要。欢迎关注威哥爱编程,分享更多技术知识。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号