目录

  1. Markdown简介
  2. 基本语法
    1. 标题
    2. 段落与换行
    3. 列表
    4. 链接与图片
    5. 引用
    6. 表格
    7. 代码
    8. 分割线
  3. 高级特性
    1. 脚注
    2. 任务列表
    3. 自定义列表标记
    4. 流程图和序列图
  4. 格式规范
    1. 文档结构
    2. 代码风格
    3. 排版与字体
  5. 常用Markdown编辑器
  6. 总结

1. Markdown简介

Markdown是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成结构化的HTML格式。Markdown具有以下优点：

  • 易于阅读和编写：Markdown的语法非常简单，易于学习和使用。
  • 兼容性强：Markdown生成的HTML文档可以在大多数浏览器中正常显示。
  • 跨平台：Markdown可以在多个平台上使用，如Windows、Mac、Linux等。

2. 基本语法

2.1 标题

Markdown支持两种标题格式：# 和 ##。

# 一级标题 ## 二级标题

2.2 段落与换行

直接在文本前后添加两个空格或一个制表符即可实现换行。

这是一个段落。 这是一个新段落。

2.3 列表

Markdown支持两种类型的列表：有序列表和无序列表。

- 无序列表项1 - 无序列表项2 - 无序列表项3 1. 有序列表项1 2. 有序列表项2 3. 有序列表项3

2.4 链接与图片

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

2.5 引用

> 这是一个引用

2.6 表格

| 表头1 | 表头2 | 表头3 | | --- | --- | --- | | 内容1 | 内容2 | 内容3 | | 内容4 | 内容5 | 内容6 |

2.7 代码

这是单行代码 
这是多行代码

2.8 分割线

---

3. 高级特性

3.1 脚注

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

3.2 任务列表

- [x] 完成任务1 - [ ] 完成任务2

3.3 自定义列表标记

- [✓] 完成任务1 - [✕] 未完成任务2

3.4 流程图和序列图

graph LR A[开始] --> B{判断} B -- 是 --> C[结束] B -- 否 --> A

4. 格式规范

4.1 文档结构

  • 使用标题组织文档结构，便于阅读和导航。
  • 使用有序列表或无序列表列出关键点，使内容更清晰。

4.2 代码风格

  • 代码块前后添加缩进，提高可读性。
  • 使用合适的代码语言标记。

4.3 排版与字体

  • 使用合适的字体和字号，确保文档易于阅读。
  • 使用空格和缩进调整格式，使文档结构更清晰。

5. 常用Markdown编辑器

  • 在线编辑器：
    • StackEdit
    • Dillinger
  • 桌面编辑器：
    • Typora
    • Visual Studio Code
  • 移动端编辑器：
    • StackEdit
    • Dillinger

6. 总结

Markdown是一种简单易用的文档格式，可以帮助我们轻松地创建清晰、易读的文档。通过掌握Markdown的基本语法和高级特性，我们可以更高效地编写文档，提高工作效率。