教程


Markdown技术文档

1. 什么是Markdown

Markdown是一种轻量级的文本标记语言,可将普通文本转换为HTML格式的文档。与WYSIWYG编辑器相比,Markdown语法简单明了,易于读写,方便修改和维护。因此,它被广泛用于博客、论坛、简历、文档等场景中。

2. Markdown的语法

2.1 标题

Markdown中的标题使用#表示,一共有六个级别。

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

2.2 段落

Markdown中的段落使用空行进行分割。

2.3 列表

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

无序列表

使用*、+、-进行表示。

* 列表项一
* 列表项二
+ 列表项三
- 列表项四

有序列表

使用数字和点进行表示。

1. 列表项一
2. 列表项二
3. 列表项三

2.4 链接

Markdown中支持两种类型的链接:内部链接和外部链接。

内部链接

[链接显示名称](链接地址)

外部链接

[链接显示名称](链接地址 "鼠标悬停提示")

2.5 图片

Markdown中插入图片语法类似于链接,区别在于前面加上了感叹号“!”。

![图片说明文字](图片链接地址 "图片标题")

2.6 强调

Markdown中使用星号或下划线进行文本的强调,一下两种表示方式等效。

*斜体*
_斜体_

**粗体**
__粗体__

2.7 引用

Markdown中使用>进行文本的引用,支持多级引用。

> 引用一级
>> 引用二级
>>> 引用三级

2.8 代码

Markdown中支持插入行内代码和代码块。

行内代码

使用反引号进行包裹。

`代码片段`

代码块

使用三个反引号进行包裹,可指定代码块的语言类型以实现代码高亮效果。

​```Java
    public static void main(String[] args) {
        System.out.println("Hello, Markdown!");
    }
​``` 

2.9 分割线

Markdown中使用三个或以上的减号、星号或下划线表示分割线。

---
***
___

3. Markdown的工具

Markdown的工具有非常多,这里介绍一下常用的几种。

3.1 Typora

Typora是一款跨平台的Markdown编辑器,支持实时预览,具有丰富的编辑功能和美观的界面,是程序员、学生、写作者等用户的首选。

3.2 VS Code

VS Code是一款轻量级的集成开发环境,内置Markdown扩展支持,可实现无缝编辑Markdown文档,并支持实时预览。

3.3 印象笔记

印象笔记是一款常用的笔记应用,支持Markdown语法,可将Markdown文档以笔记的形式保存,非常方便。

4. 结语

Markdown语法简单易学,使用广泛,本文仅介绍Markdown的基本语法和常用工具,更多高级用法和实践经验需要读者自行深入学习和实践。