Markdown文档编写指南

Markdown 简介

Markdown 是一种轻量级标记语言，用简单易读的纯文本格式编写文档，可转换为HTML或其他格式。

特点：

• 扩展名：.md 或 .markdown

• 兼容性强（GitHub、VS Code、Typora等均支持）

• 支持HTML嵌套

基础语法

2.1 标题

替代语法（仅H1/H2）：

2.2 段落与换行

• 段落：空一行分隔段落

• 换行：行尾添加两个空格或<br>

2.3 文字样式

2.4 列表

无序列表：

2.5 链接与图片

2.6 引用

2.7 代码块

行内代码：
`code`

多行代码：

或缩进4空格：

2.8 分隔线

3. 进阶语法

3.1 表格

3.2 任务列表（GitHub扩展）

3.3 脚注

3.4 内嵌HTML

3.5 目录（部分解析器支持）

4. 扩展语法（GFM/CommonMark）

4.1 GitHub Flavored Markdown (GFM)

• 表情符号：:smile: → ?

• 高亮：==重点== → ==重点==

• 自动链接：https://example.com

4.2 数学公式（KaTeX）

5. 工具推荐

1. 编辑器：

• VS Code（+ Markdown All in One插件）

• Typora（所见即所得）

• Obsidian（知识管理）

2. 在线工具：

• Markdown Live Preview

• Dillinger

6. 最佳实践

1. 标题层级从H1开始依次递减

2. 列表统一使用-符号

3. 代码块指定语言以获得语法高亮

4. 长表格建议用HTML实现

5. 插入大图时使用引用链接保持可读性

示例完整文档：

掌握这些语法后，你可以高效编写文档、笔记、博客等内容。Markdown的灵活性和简洁性使其成为开发者和写作者的首选工具。