Skip to main content

Markdown

Markdown 是什么?

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

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

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

Visual Studio Code文本编辑器中的标记文件

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

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

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

为什么使用Markdown?

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

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

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

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

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

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

踢轮胎

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

你甚至不需要下载任何东西。有几个在线Markdown编辑器可用于尝试在Markdown中编写。Dillinger是最好的在线Markdown编辑之一。只需打开网站,然后在左侧窗格中开始键入。渲染文档的预览显示在右侧窗格中。

Dillinger Markdown编辑器

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

它是如何工作的?

Dillinger使Markdown的写作变得简单,因为它隐藏了幕后发生的事情,但值得探索整个过程是如何运作的。

当您在Markdown中写入时,文本存储在具有.md.markdown扩展名的纯文本文件中。但那又怎样?您的Markdown格式文件如何转换为HTML或可打印文档?

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

Markdown应用程序使用一种名为Markdown处理器的东西(通常也称为“解析器”或“实现”)来获取Markdown格式的文本并将其输出为HTML格式。届时,您的文档可以在网页浏览器中查看,也可以与样式表相结合并打印。您可以在下面看到此过程的可视化表示注:Markdown应用程序和处理器是两个独立的组件。为了简短起见,我把它们合并到下图中的一个元素(“Markdown应用程序”)中。

减价流程

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

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

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

减价有什么好处?

Markdown是一种快速简便的方式,可以记笔记、为网站创建内容和制作可打印文档。

学习Markdown语法不需要很长时间,一旦你学会了如何使用它,你几乎可以在任何地方使用Markdown写作。大多数人使用Markdown为网络创建内容,但Markdown有利于格式化从电子邮件到杂货清单的所有内容。

以下是一些你可以用Markdown做什么的例子。

网站

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

如果您正在寻找使用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格式文档的模板。例如,“学术-MLA风格”模板缩进段落并添加双句间距。

笔记

在几乎所有方面,Markdown都是记笔记的理想语法。可悲的是,最受欢迎的两个Note应用程序EvernoteOneNote目前不支持Markdown。好消息是,其他几个笔记应用程序确实支持Markdown:

  • Obsidian是一款流行的Markdown记笔记应用程序,包含功能。
  • Simplenote是一个免费的裸骨笔记应用程序,适用于每个平台。
  • 值得注意的是,这是一个在各种平台上运行的笔记应用程序。
  • Bear是一个类似于Evernote的应用程序,适用于Mac和iOS设备。默认情况下,它不只使用Markdown,但您可以启用Markdown兼容性模式。
  • Joplin是一个尊重您隐私的笔记应用程序。它适用于每个平台。
  • Boostnote本身是一个“为程序员设计的开源笔记应用程序”。

如果您无法放弃Evernote,请查看Evernote基于订阅的Markdown编辑器Marxico,或将Markdown Here与Evernote网站一起使用。

书籍

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

演示文稿

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

电子邮件

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

协作

协作和团队消息应用程序是与同事和朋友在工作和家庭中沟通的一种流行方式。这些应用程序没有使用Markdown的所有功能,但它们提供的功能相当有用。例如,无需使用WYSIWYG界面即可粗体和斜体显示文本非常方便。SlackDiscordWiki.jsMattermost都是很好的协作应用程序。

文档

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

  • 阅读文档可以从您的开源Markdown文件中生成文档网站。只需将您的GitHub存储库连接到他们的服务并推送——阅读文档即可完成其余操作。他们还为商业实体提供服务
  • MkDocs是一种快速简单的静态站点生成器,旨在构建项目文档。文档源文件用Markdown编写,并使用单个YAML配置文件进行配置。MkDocs有几个内置主题,包括一个用于MkDocs的Read the Docs文档主题端口。最新的主题之一是MkDocs Material
  • Docusaurus是一个静态网站生成器,专为创建文档网站而设计。它支持翻译、搜索和版本管理。
  • VuePress是由Vue供电的静态站点发电机,经过优化以编写技术文档。
  • Jekyll早些时候在网站上的章节中被提及,但它也是从Markdown文件中生成文档网站的好选择。如果您走这条路,请务必查看Jekyll文档主题

Markdown的味道

使用Markdown最令人困惑的一个方面是,几乎每个Markdown应用程序都实现的Markdown版本略有不同。Markdown的这些变体通常被称为风味。掌握应用程序已实现的任何口味的Markdown都是您的工作。

要将你的头环顾Markdown口味的概念,将其视为语言方言可能会有所帮助。纽约市的人说英语和伦敦人一样,但这两个城市使用的方言之间有很大差异。使用不同Markdown应用程序的人也是如此。使用Dillinger使用Markdown写作与使用Ulysses有很大不同。

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

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

其他资源

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