Markdown入门教程：从基础语法到实战应用

Markdown入门教程：从基础语法到实战应用

Markdown是一种轻量级标记语言，广泛应用于技术文档编写、博客创作等领域。本文将从Markdown的基本概念、应用、语法和使用技巧等方面，帮助读者快速掌握Markdown的使用方法。

1. 引子

人们在开发软件的时候，经常需要编写文档。最早期的时候，文档就是使用最简单的文本格式编写的，比如txt文件。那时候的软件说明文档文件名通常为ReadMe.txt，人们随便使用一个简单文本编辑器就可以查看。然而，简单的文本文件不支持任何格式，比如标题、列表、图片等等，这给阅读和分享带来了很大的不便。

后来，人们尝试使用一些专用软件，如Word，来编写软件说明文档。然而，这些专用软件虽然功能强大，但需要付费，有时还需要专用软件才能打开，不利于文档的传播。而且对于使用者来说，学会专用软件编写文档本身就需要耗费一定的精力。另外一个显著的缺点就是，这种文档虽然支持丰富的格式，但因为没有统一的格式规范，导致不同人编写的文档格式差异很大。这使得，即使是在同一个项目中，文档的格式也可能千差万别，那么全世界不同开发者为不同项目编写的文档更是千差万别。这非常不利于文档的传播和维护。

2. Markdown简介与应用

2.1 Markdown是什么？

Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。Markdown编写的文档可以导出HTML、PDF等多种格式的文档。并且由于有着统一的格式规范，使得即使是不同的人编写的Markdown文档，也能在几乎所有Markdown解析器上正确显示。这使得Markdown文档可以被非常广泛地传播和使用。本篇文章就是使用Markdown所编写。

2.2 Markdown的应用

在计算机行业，Markdown有着广泛的应用。包括但不限于如下几种：

• 示例：代码管理站上项目的说明文档

GitHub是一个著名的代码管理站，上的很多开源项目都提供了Markdown格式的文档，比如，打开openjdk在GitHub上的项目主页，可以看到如下图所示页面：

红色方框框起来的就是README.md文件，这个文件就是使用Markdown编写的。箭头所指的区域就是GitHub对Markdown格式的文档所作的渲染，可以看到，这个文档被渲染成了一个比较美观的网页。

• 示例：博客文档

除了代码管理站点GitHub之外，还有很多博客网站也支持使用Markdown格式编写博客。比如国内的博客园、CSDN博客、简书等。

作者的教学博客上的绝大部分文章也使用了Markdown编写。下图为作者的一篇使用Makrdown编写的博客文章页面：

这个页面对应的部分Markdown文本如下所示：

图片中的

[TOC] ** # -

等就是Markdown标记。

3. 学习Markdown

初学者应掌握Markdown的一些基本概念，如基本的格式符号、常用的标记语法和一些常用工具。

3.1 Markdown的相关工具

支持Markdown的工具与服务种类繁多，包括：

• 本地文本编辑器：如Typora、VSCode（需要安装Markdown插件）等。
• 在线Markdown编辑器：如StackEdit、Cmd Markdown等。
• 支持Markdown的博客：博客园、CSDN、简书等。
• 支持Markdown的代码管理站点：如GitHub、Gitee等。
• 支持文档转换的软件：如Pandoc等。

建议：

• 编写：作为初学者可以先直接使用在线Markdown编辑器试水，熟悉Markdown语法后，再使用本地文本编辑器编写Markdown文档。
• 文档格式转换：有的本地编辑器通过安装插件，可以很方便的将Markdown文本文件转换成HTML格式，并直接在浏览器中预览效果，还有的插件甚至可以直接将Markdown文本转换成PDF格式。
• 编写博客：直接找一个支持Markdown的博客网站即可。前面列举的博客网站均支持Markdown格式，并提供预览功能。

3.2 基本概念与标记符号

Markdown虽然以简单著称，但作为初学者，还是需要掌握一些基本概念与简单标记。

3.2.1 基本概念

• 标记符号

Markdown文本中使用的特殊符号。编写文本时使用某些标记符号，渲染工具会将其转换成HTML格式。

• 文件扩展名

Makrdown文件的扩展名为

.md

。

• 渲染

指的是将Markdown文本转换为最终可视化输出的过程。这包括将Markdown文本解析并转换为HTML、PDF、Word等格式，以便用户能够查看或分享最终呈现的文档。渲染这个概念是Markdown的核心概念，也是Markdown与其它格式文档最大的区别。

• 图床

Makrdown文件为纯文本文件，无法放置图片只能放置图片的文本链接。图片本身要么被存放在本机（比如与.md文件相同的目录），要么存放在网络上的某个服务器并能通过网络链接访问。这个专门用来存放图片的服务器称为图床。不过通常编写网络文章（比如博客），博客网站都会提供存放图片的方法，编写者无需操心图片的存储问题。

• 方言（Dialect）

指基于Markdown语法的扩展或变种，如GitHub Flavored Markdown（GFM）、CommonMark等。这些方言在原始Markdown语法的基础上添加了额外的功能或规范，以满足特定需求或提供更丰富的功能。初学者只需使用原始的Markdown语法即可，无需了解其它方言。

3.2.2 基本的标记符号

可以将Markdown编写的文本理解成一个代码文件，其中包含一些特殊的标记符号。渲染工具会将这些标记符号转换成HTML格式，并将其显示在网页上。因此，编写者需要掌握基本的标记符号。常用的标记符号有：

• 标题：使用

标记不同级别的标题，

的个数代表了标题的级别，

的个数不能超过6个。通常Markdown文章的第一行放置一级标题（使用一个

标记），作为文章名称。

• 段落：使用一个或多个空行分隔多个段落。通常Markdown文本的段落行首不需要缩进（简单的讲，不需要加空格）。

• 换行：使用两个空格加回车符（

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