开始

Markdown 概述、它的工作原理以及您可以使用它做什么。

什么是 Markdown?

Markdown 是一种轻量级标记语言,可用于向纯文本文档添加格式元素。Markdown 由 John Gruber 于 2004 年创建,现在是世界上最受欢迎的标记语言之一。

使用 Markdown 与使用 WYSIWYG 编辑器不同。在 Microsoft Word 等应用程序中,单击按钮以设置单词和短语的格式,更改会立即可见。Markdown 不是那样的。创建 Markdown 格式的文件时,将 Markdown 语法添加到文本中,以指示哪些单词和短语看起来应该不同。

例如,要表示标题,请在标题前添加一个数字符号(例如,)。或者,要将短语设为粗体,请在其前后添加两个星号(例如,)。可能需要一段时间才能习惯在文本中看到 Markdown 语法,特别是如果您习惯了所见即所得的应用程序。下面的屏幕截图显示了 Visual Studio Code 文本编辑器中显示的 Markdown 文件。# Heading One**this text is bold**

Visual Studio Code 文本编辑器中的 Markdown 文件

您可以使用文本编辑器应用程序将 Markdown 格式元素添加到纯文本文件中。或者,您可以使用适用于 macOS、Windows、Linux、iOS 和 Android作系统的众多 Markdown 应用程序之一。还有一些基于 Web 的应用程序专门用于使用 Markdown 编写。

根据您使用的应用程序,您可能无法实时预览格式化文档。但这没关系。根据 Gruber 的说法,Markdown 语法旨在可读且不引人注目,因此即使 Markdown 文件中的文本没有呈现,也可以被读取。

Markdown 格式语法的首要设计目标是使其尽可能可读。这个想法是,Markdown 格式的文档应该可以按原样以纯文本形式发布,而不是看起来像是用标签或格式说明标记的。

为什么使用 Markdown?

您可能想知道为什么人们使用 Markdown 而不是所见即所得的编辑器。当您可以按下界面中的按钮来格式化文本时,为什么还要使用 Markdown 编写呢?事实证明,人们使用 Markdown 而不是所见即所得的编辑器有几个原因。

  • Markdown 可用于所有事情。人们使用它来创建网站文档笔记书籍演示文稿电子邮件和技术文档

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

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

  • Markdown 是面向未来的。即使您正在使用的应用程序在未来某个时候停止工作,您仍然可以使用文本编辑应用程序阅读 Markdown 格式的文本。当涉及到需要无限期保存的书籍、大学论文和其他里程碑文件时,这是一个重要的考虑因素。

  • Markdown 无处不在。Reddit 和 GitHub 等网站支持 Markdown,许多桌面和基于 Web 的应用程序都支持它。

手动实践

开始使用 Markdown 的最佳方式是使用它。多亏了各种免费工具,这比以往任何时候都更容易。

您甚至不需要下载任何内容。您可以使用几个在线 Markdown 编辑器来尝试在 Markdown 中编写。Dillinger 是最好的在线 Markdown 编辑器之一。只需打开站点并开始在左侧窗格中键入即可。呈现的文档的预览将显示在右侧窗格中。

Dillinger Markdown 编辑器

在阅读本指南时,您可能希望保持 Dillinger 网站打开。这样,您就可以在学习语法时尝试它。熟悉 Markdown 后,您可能希望使用可以安装在台式计算机或移动设备上的 Markdown 应用程序。

它是如何工作的?

Dillinger 使 Markdown 写作变得容易,因为它隐藏了幕后发生的事情,但值得探索这个过程通常是如何工作的。

当您在 Markdown 中写入时,文本将存储在扩展名为 or 的纯文本文件中。但然后呢?您的 Markdown 格式文件如何转换为 HTML 或可打印文档?.md.markdown

简短的回答是,您需要一个能够处理 Markdown 文件的 Markdown 应用程序。有许多应用程序可用 — 从简单的脚本到看起来像 Microsoft Word 的桌面应用程序,应有尽有。尽管它们在视觉上有所不同,但所有应用程序都做同样的事情。与 Dillinger 一样,它们都将 Markdown 格式的文本转换为 HTML,以便它可以在 Web 浏览器中显示。

Markdown 应用程序使用称为 Markdown 处理器(通常也称为“解析器”或“实现”)的东西来获取 Markdown 格式的文本并将其输出为 HTML 格式。此时,可以在 Web 浏览器中查看文档,也可以将其与样式表结合使用并打印。您可以在下面看到此过程的可视化表示。

注意:Markdown 应用程序和处理器是两个独立的组件。为简洁起见,我在下图中将它们合并为一个元素(“Markdown 应用程序”)。

The Markdown Process

总而言之,这是一个由四部分组成的过程:

  1. 使用文本编辑器或专用 Markdown 应用程序创建 Markdown 文件。该文件应具有 or 扩展名。.md.markdown
  2. 在 Markdown 应用程序中打开 Markdown 文件。
  3. 使用 Markdown 应用程序将 Markdown 文件转换为 HTML 文档。
  4. 在 Web 浏览器中查看 HTML 文件,或使用 Markdown 应用程序将其转换为其他文件格式,如 PDF。

从您的角度来看,该过程会因您使用的应用程序而有所不同。例如,Dillinger 基本上将步骤 1-3 合并到一个无缝界面中 — 您只需在左侧窗格中键入内容,渲染的输出就会神奇地出现在右侧窗格中。但是,如果您使用其他工具,例如带有静态网站生成器的文本编辑器,您会发现该过程更加明显。

Markdown 有什么用?

Markdown 是一种快速简便的记笔记、为网站创建内容和生成可打印文档的方法。

学习 Markdown 语法并不需要很长时间,一旦你知道如何使用它,你几乎可以在任何地方使用 Markdown 进行编写。大多数人使用 Markdown 来创建 Web 内容,但 Markdown 非常适合格式化从电子邮件到购物清单的所有内容。

以下是您可以使用 Markdown 执行作的一些示例。

网站

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

如果您正在寻找使用 Markdown 文件创建网站的最简单方法,请查看 blot.im。注册 Blot 后,它会在您的电脑上创建一个 Dropbox 文件夹。只需将您的 Markdown 文件拖放到文件夹中,然后 - 噗!— 它们在您的网站上。这再简单不过了。

如果您熟悉 HTML、CSS 和版本控制,请查看 Jekyll,这是一个流行的静态站点生成器,它接受 Markdown 文件并构建 HTML 网站。这种方法的一个优点是 GitHub Pages 为 Jekyll 生成的网站提供免费托管。如果 Jekyll 不是您的菜,只需从许多其他可用的静态站点生成器中选择一个。

注意:我使用 Jekyll 创建了 Markdown 指南。您可以在 GitHub 上查看源代码。

如果您想使用内容管理系统 (CMS) 来支持您的网站,请查看 Ghost。这是一个免费的开源博客平台,带有漂亮的 Markdown 编辑器。如果您是 WordPress 用户,您会很高兴知道 WordPress.com 上托管的网站支持 Markdown。自托管的 WordPress 网站可以使用 Jetpack 插件

文件

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

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

提示: iA Writer 提供了用于预览、打印和导出 Markdown 格式文档的模板。例如,“Academic – MLA Style” 模板缩进段落并添加双倍句子间距。

笔记

几乎在所有方面,Markdown 都是记笔记的理想语法。遗憾的是,EvernoteOneNote 这两个最流行的笔记应用程序目前不支持 Markdown。好消息是,其他几个 note 应用程序确实支持 Markdown:

  • Obsidian 是一款流行的 Markdown 笔记应用程序,加载了多种功能。
  • Simplenote 是一个免费的准系统笔记应用程序,可用于每个平台。
  • 值得注意的是,它是一款在各种平台上运行的笔记应用程序。
  • 熊掌记是一款类似 Evernote 的应用程序,适用于 Mac 和 iOS 设备。默认情况下,它不专门使用 Markdown,但您可以启用 Markdown 兼容模式。
  • Joplin 是一个尊重您隐私的笔记应用程序。它适用于每个平台。
  • Boostnote 将自己标榜为“专为程序员设计的开源笔记应用程序”。

如果你不能放弃 Evernote,请查看 Marxico,一个基于 Evernote 的订阅式 Markdown 编辑器,或者通过 Evernote 网站使用 Markdown Here

参考图书

想要自行出版小说?试试 Leanpub,这是一项将 Markdown 格式的文件转换为电子书的服务。Leanpub 以 PDF、EPUB 和 MOBI 文件格式输出您的图书。如果您想创建图书的平装副本,可以将 PDF 文件上传到其他服务,例如 Kindle 自助出版。要了解有关使用 Markdown 编写和自行出版书籍的更多信息,请阅读此博客文章

介绍

信不信由你,您可以从 Markdown 格式的文件生成演示文稿。在 Markdown 中创建演示文稿需要一点时间来适应,但一旦你掌握了窍门,它比使用 PowerPoint 或 Keynote 等应用程序要快得多,也容易得多。RemarkGitHub 项目)是一种流行的基于浏览器的 Markdown 幻灯片工具,CleaverGitHub 项目)和 MarpGitHub 项目)也是如此。如果您使用的是 Mac 并希望使用应用程序,请查看 DecksetHyperdeck

电子邮件

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

协作

协作和团队消息传递应用程序是与同事和朋友在工作和家中交流的一种流行方式。这些应用程序并未利用 Markdown 的所有功能,但它们提供的功能相当有用。例如,在不使用 WYSIWYG 界面的情况下将文本加粗和斜体的功能非常方便。SlackDiscord Wiki.jsMattermost 都是很好的协作应用程序。

文档

Markdown 非常适合技术文档。像 GitHub 这样的公司越来越多地改用 Markdown 来编写文档 — 查看他们的博客文章,了解他们如何将 Markdown 格式的文档迁移到 Jekyll。如果您为产品或服务编写文档,请查看以下方便的工具:

  • 阅读文档可以从你的开源 Markdown 文件生成一个文档网站。只需将您的 GitHub 存储库连接到他们的服务并推送 — Read the Docs 会完成剩下的工作。他们还提供面向商业实体的服务
  • MkDocs 是一个快速简单的静态站点生成器,适用于构建项目文档。文档源文件是用 Markdown 编写的,并使用单个 YAML 配置文件进行配置。MkDocs 有几个内置主题,包括用于 MkDocs 的 Read the Docs 文档主题的端口。最新的主题之一是 MkDocs Material
  • Docusaurus 是一个静态网站生成器,专为创建文档网站而设计。它支持翻译、搜索和版本控制。
  • VuePress 是一个由 Vue 提供支持的静态站点生成器,并针对编写技术文档进行了优化。
  • Jekyll 在前面的网站部分提到过,但它也是从 Markdown 文件生成文档网站的不错选择。如果你走这条路,请务必查看 Jekyll 文档主题

Markdown 的风格

使用 Markdown 最令人困惑的方面之一是,实际上每个 Markdown 应用程序实现的 Markdown 版本略有不同。Markdown 的这些变体通常称为 flavor。你的工作是掌握你的应用程序已经实现的任何 Markdown 风格。

要了解 Markdown 风格的概念,将它们视为语言方言可能会有所帮助。纽约市的人和伦敦人一样说英语,但两个城市使用的方言之间存在很大差异。对于使用不同 Markdown 应用程序的人来说也是如此。使用 Dillinger 通过 Markdown 进行写作与使用 Ulysses 的体验截然不同。

实际上,这意味着你永远不知道一家公司说他们支持 “Markdown” 的确切含义。他们是只谈论基本语法元素,还是所有基本和扩展语法元素的组合,或者语法元素的任意组合?在您阅读文档或开始使用该应用程序之前,您不会知道。

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

其他资源

您可以使用许多资源来学习 Markdown。以下是一些其他介绍性资源:

将您的 Markdown 技能提升到一个新的水平。

在 60 页中学习 Markdown。《Markdown 指南》专为新手和专家设计,是一本全面的参考书,包含您入门和掌握 Markdown 语法所需的一切。

获取书籍