入门指南

Markdown 概述，即其工作原理，以及您可以用它来做什么。

什么是 Markdown？

Markdown 是一种轻量级标记语言，您可以使用它在纯文本文档中添加格式化元素。Markdown 由 John Gruber (opens new window) 于 2004 年创建，如今已成为世界上最流行的标记语言之一。

使用 Markdown 与使用所见即所得 （WYSIWYG） (opens new window) 编辑器有所不同。在 Microsoft Word 这类应用程序中，您通过点击按钮来格式化文字和短语，更改会立即显示出来。Markdown 则并非如此。当您创建一个 Markdown 格式的文件时，您在文本中添加 Markdown 语法，用来指示哪些文字和短语应该显示为不同的样式。

例如，要表示一个标题，您在它前面添加一个井号（例如，# 标题一）。或者要让一个短语加粗，您在它前后各添加两个星号（例如，**这段文字是加粗的**）。您可能需要一段时间来适应在文本中看到 Markdown 语法，尤其是如果您习惯了所见即所得的应用程序。下面的截图展示了一个在 Visual Studio Code 文本编辑器中显示的 Markdown 文件。

您可以使用文本编辑器应用程序将 Markdown 格式元素添加到纯文本文件中。或者，您也可以使用众多适用于 macOS、Windows、Linux、iOS 和 Android 操作系统的 Markdown 应用程序之一。此外，还有几个专门为 Markdown 写作设计的基于网页的应用程序。

根据您所使用的应用程序，您可能无法实时预览格式化后的文档。但这没关系。据 Gruber 所说 (opens new window)，Markdown 语法的设计初衷就是可读且不突兀，因此即使 Markdown 文件未被渲染，其中的文本也是可读的。

Markdown 格式语法的首要设计目标是使其尽可能具有可读性。其理念是，一份 Markdown 格式的文档应该能够以原样发布为纯文本，而不会看起来像是被标签或格式指令标记过的。

为何使用 Markdown？

您可能会好奇，为什么人们会选择使用 Markdown 而不是所见即所得（WYSIWYG）编辑器。既然可以通过界面上的按钮来设置文本格式，为何还要使用 Markdown 呢？事实证明，人们选择使用 Markdown 而非所见即所得编辑器的原因有以下几点。

• Markdown 用途广泛。人们使用它来创建网站、文档、笔记、书籍、演示文稿、电子邮件和技术文档。

• Markdown 是可移植的。几乎任何应用程序都能打开包含 Markdown 格式文本的文件。如果您不喜欢当前使用的 Markdown 应用程序，可以将 Markdown 文件导入到另一个 Markdown 应用程序中。这与 Microsoft Word 等文字处理应用程序形成鲜明对比，后者会将您的内容锁定在专有的文件格式中。

• Markdown 是跨平台的。您可以在运行任何操作系统的任何设备上创建 Markdown 格式的文本。

• Markdown 具有前瞻性。即使您正在使用的应用程序在未来某个时候停止运行，您仍然可以使用文本编辑应用程序来阅读您的 Markdown 格式文本。对于书籍、大学论文和其他需要永久保存的重要文件而言，这是一个重要的考虑因素。

• Markdown 无处不在。像 Reddit 和 GitHub 这样的网站都支持 Markdown ，许多基于桌面和网页的应用程序也支持它。

试试看

开始使用 Markdown 的最佳方式就是直接用它。得益于各种免费工具，这比以往任何时候都更容易。

您甚至不需要下载任何东西。有几个在线 Markdown 编辑器可以让您尝试用 Markdown 写作。JotBird (opens new window)（原作者开发的）是最好的在线 Markdown 编辑器之一。只需打开网站，然后在左侧窗格中开始输入。右侧窗格会显示渲染后文档的预览。

在阅读本指南时，您可能希望保持 JotBird 网站处于打开状态。这样，您就可以在学习语法的同时进行尝试。当您熟悉了 Markdown 之后，您可能想要使用一款可以安装在桌面电脑或移动设备上的 Markdown 应用程序。

它是如何工作的？

JotBird 让使用 Markdown 写作变得简单，因为它隐藏了幕后发生的事情，但了解一下整个过程的一般工作原理是值得的。

当您用 Markdown 写作时，文本存储在一个带有 .md 或 .markdown 扩展名的纯文本文件中。但接下来呢？您的 Markdown 格式文件是如何被转换为 HTML 或可打印文档的？

简而言之，您需要一个能够处理 Markdown 文件的 Markdown 应用程序。市面上有很多这样的应用程序——从简单的脚本到外观酷似 Microsoft Word 的桌面应用程序，不一而足。尽管它们在视觉上存在差异，但所有应用程序的功能都是相同的。像 JotBird 一样，它们都将 Markdown 格式的文本转换为 HTML，以便在网页浏览器中显示。

Markdown 应用程序使用一种称为 Markdown 处理器（通常也称为“解析器”或“实现”）的工具，将 Markdown 格式的文本转换为 HTML 格式。此时，您可以在网页浏览器中查看文档，或者将其与样式表结合使用并进行打印。您可以在下方看到此过程的可视化表示。

注意：Markdown 应用程序和处理器是两个独立的组件。为了简洁起见，我在下图中将它们合并为一个元素（"Markdown 应用"）。

总而言之，这是一个分为四个部分的过程：

1. 使用文本编辑器或专用的 Markdown 应用程序创建一个 Markdown 文件。该文件应具有 .md 或 .markdown 扩展名。

2. 在 Markdown 应用程序中打开 Markdown 文件。

3. 使用 Markdown 应用程序将 Markdown 文件转换为 HTML 文档。

4. 在网页浏览器中查看 HTML 文件，或使用 Markdown 应用程序将其转换为另一种文件格式，如 PDF。

从您的角度来看，整个过程会因您所使用的应用而略有不同。例如，JotBird 基本上将步骤 1-3 整合到一个无缝的界面中——您所要做的就是在左侧面板中输入内容，然后渲染后的输出就会神奇地出现在右侧面板中。但如果您使用其他工具，比如带有静态网站生成器的文本编辑器，您会发现整个过程要清晰得多。

Markdown 适合做什么？

Markdown 是一种快速且简便的方法，可用于记笔记、为网站创建内容以及生成可直接打印的文档。

学习 Markdown 语法并不需要很长时间，一旦您掌握了它的使用方法，您几乎可以在任何地方使用 Markdown 进行写作。大多数人使用 Markdown 为网页创建内容，但 Markdown 同样适用于从电子邮件到购物清单等各种内容的格式化。

以下是一些使用 Markdown 的示例。

网站

Markdown 是为网络设计的，因此，有很多专门用于创建网站内容的应用程序也就不足为奇了。

如果您正在寻找一种尽可能简单的方法，用 Markdown 文件来创建网站，那么不妨试试 blot.im (opens new window)。注册 Blot 后，它会在您的电脑上创建一个 Dropbox 文件夹。只需将您的 Markdown 文件拖放到该文件夹中，然后 —— 噗！—— 它们就出现在您的网站上了。简直易如反掌。

如果您熟悉 HTML、CSS 和版本控制，不妨试试 Jekyll，它是一款流行的静态站点生成器，能够接收 Markdown 文件并构建出一个 HTML 网站。这种方法的一个优点是，GitHub Pages 为 Jekyll 生成的网站提供免费托管服务。如果您不喜欢 Jekyll，还可以从众多其他静态站点生成器 (opens new window)中选择一款。

注：如果您想学习如何从零开始构建静态网站，可以看看原作者写的另一本书《静态网站指南》 (opens new window)。

如果您想使用内容管理系统（CMS）来搭建您的网站，不妨了解一下 Ghost。它是一个免费且开源的博客平台，配备了一个不错的 Markdown 编辑器。如果您是 WordPress 用户，您会很高兴地知道，WordPress.com 托管的网站支持 Markdown (opens new window)。自托管的 WordPress 网站可以使用 Jetpack 插件 (opens new window)。

文档

Markdown 没有像 Microsoft Word 那样的文字处理器的所有花哨功能，但它足以创建基本的文档，如作业和信件。您可以使用 Markdown 文档创作应用程序来创建 Markdown 格式的文档，并将其导出为 PDF 或 HTML 文件格式。PDF 部分是关键，因为一旦您有了 PDF 文档，您就可以用它做任何事情——打印它、通过电子邮件发送它，或将其上传到网站。

以下是我推荐的一些 Markdown 文档创作应用程序：

• Mac系统：MacDown、iA Writer 或 Marked 2
• iOS / Android系统：iA Writer
• Windows系统：ghostwriter (opens new window) 或 Markdown Monster (opens new window)
• Linux系统：ReText (opens new window) 或 ghostwriter (opens new window)
• 网页：JotBird，Dillinger 或 StackEdit

提示：iA Writer (opens new window) 提供了用于预览、打印和导出 Markdown 格式文档的模板。例如，"学术 – MLA 风格" 模板会缩进段落并添加双倍句间距。

笔记

几乎在所有方面，Markdown 都是记笔记的理想语法。遗憾的是，最受欢迎的笔记应用程序中的两个——Evernote (opens new window) 和 OneNote (opens new window)——目前不支持 Markdown。好消息是其他几个笔记应用程序确实支持 Markdown：

• Obsidian 是一款功能丰富的流行 Markdown 笔记应用程序。
• Simplenote 是一款免费的、极简的笔记应用程序，适用于所有平台。
• Notable 是一款可在多种平台上运行的笔记应用程序。
• Bear 是一款类似 Evernote 的应用程序，适用于 Mac 和 iOS 设备。它默认不专门使用 Markdown，但您可以启用 Markdown 兼容模式。
• Joplin 是一款尊重您隐私的笔记应用程序。它适用于所有平台。

如果您无法放弃 Evernote，可以看看 Marxico (opens new window)——一款基于订阅的 Evernote Markdown 编辑器，或者在 Evernote 网站上使用 Markdown Here。

书籍

想自出版一本小说吗？试试 Leanpub (opens new window)，这是一项将您的 Markdown 格式文件转换为电子书的服务。Leanpub 会以 PDF、EPUB 和 MOBI 文件格式输出您的书。如果您想创建书籍的平装本，可以将 PDF 文件上传到另一项服务，如 Kindle Direct Publishing (opens new window)。要了解更多关于使用 Markdown 写作和自出版书籍的信息，请阅读这篇博客文章 (opens new window)。

演示文稿

信不信由您，您可以从 Markdown 格式的文件生成演示文稿。虽然用 Markdown 创建演示文稿需要一点时间来适应，但一旦您掌握了诀窍，它会比使用 PowerPoint 或 Keynote 等应用程序快得多也容易得多。Remark (opens new window)（GitHub 项目 (opens new window)）是一款流行的基于浏览器的 Markdown 幻灯片工具，Clever (opens new window)（GitHub 项目 (opens new window)）和 Marp (opens new window)（GitHub 项目 (opens new window)）也是如此。如果您使用 Mac 电脑并且更愿意使用应用程序，可以看看 Deckset (opens new window) 或 Hyperdeck (opens new window)。

电子邮件

如果您发送大量电子邮件，并且厌倦了大多数电子邮件提供商网站上可用的格式控制，您会很高兴知道，有一种简单的方法可以用 Markdown 编写电子邮件。Markdown Here 是一个免费的开源浏览器扩展，可将 Markdown 格式的文本转换为可以发送的 HTML。

协作

协作和团队消息应用程序是在工作和家中与同事和朋友交流的流行方式。这些应用程序并未充分利用 Markdown 的所有功能，但它们提供的功能相当实用。例如，无需使用所见即所得界面就能加粗和斜体文本的能力就非常方便。Slack、Discord、Wiki.js 和 Mattermost 都是不错的协作应用程序。

文档

Markdown 非常适合技术文档。像 GitHub 这样的公司正越来越多地转向使用 Markdown 来编写文档——查看他们关于如何将 Markdown 格式的文档迁移到 Jekyll 的博客文章 (opens new window)。如果您为产品或服务编写文档，可以看看这些方便的工具：

• Read the Docs (opens new window) 可以从您的开源 Markdown 文件生成一个文档网站。只需将您的 GitHub 仓库连接到他们的服务并推送——Read the Docs 会完成其余的工作。他们也有面向商业实体的服务 (opens new window)。
• MkDocs 是一个快速而简单的静态网站生成器，专门用于构建项目文档。文档源文件用 Markdown 编写，并通过一个 YAML 配置文件进行配置。MkDocs 有几个内置主题 (opens new window)，包括 Read the Docs (opens new window) 文档主题的移植版本，可用于 MkDocs。其中最新的主题之一是 MkDocs Material (opens new window)。
• Docusaurus 是一个专为创建文档网站而设计的静态网站生成器。它支持翻译、搜索和版本管理。
• VuePress (opens new window) 是一个由 Vue (opens new window) 驱动的静态网站生成器，专为编写技术文档而优化。
• Jekyll 在前面的网站部分已经提到过，但它也是从 Markdown 文件生成文档网站的一个不错选择。如果您选择这条路线，一定要看看 Jekyll 文档主题 (opens new window)。

Markdown 的风格

使用 Markdown 最令人困惑的方面之一是，几乎每个 Markdown 应用程序都实现了一个略有不同的 Markdown 版本。这些 Markdown 的风格通常被称为"风格（flavors）"。您需要掌握您的应用程序所实现的任何一种 Markdown 风格。

要理解 Markdown 风格的概念，将它们想象成语言方言可能会有所帮助。纽约市的人和伦敦的人一样都说英语，但两个城市使用的方言之间存在显著差异。使用不同 Markdown 应用程序的人也是如此。使用 JotBird 进行 Markdown 写作与使用 Ulysses 的体验截然不同。

实际上，这意味着当一家公司说他们支持"Markdown"时，您永远不知道他们到底是什么意思。他们是在说仅支持基本语法元素，还是所有基本语法和扩展语法元素的组合，还是某种任意的语法元素组合？您只有阅读文档或开始使用该应用程序后才会知道。

如果您刚刚起步，我能给您的最好建议是选择一款具有良好 Markdown 支持的 Markdown 应用程序。这对保持您的 Markdown 文件的可移植性大有帮助。您可能希望在其他应用程序中存储和使用您的 Markdown 文件，为此，您需要从一款提供良好支持的应用程序开始。您可以使用工具目录来找到一款符合要求的应用程序。

其他资源

您可以使用很多资源来学习 Markdown。以下是一些其他入门资源：

• John Gruber 的 Markdown 文档 (opens new window)。由 Markdown 创作者编写的原始指南。
• Markdown Tutorial (opens new window)。一个开源网站，允许您在网页浏览器中尝试 Markdown。
• Awesome Markdown (opens new window)。一份 Markdown 工具和学习资源的列表。
• Typesetting Markdown (opens new window)。一个多部分的系列文章，描述了使用 pandoc (opens new window) 和 ConTeXt (opens new window) 对 Markdown 文档进行排版的生态系统。