Markdown 入门

目录

MarkDown是什么?

Markdown是一种轻量级的标记语言,可用于将格式设置元素添加到纯文本文档中。Markdown 由John Gruber于2004年创建,如今已成为世界上最受欢迎的标记语言之一。

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

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

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

根据您使用的应用程序,您可能无法实时预览格式化的文档。但这没关系。根据Gruber的说法,Markdown语法被设计为可读性强且不显眼,因此即使未呈现Markdown文件中的文本也可以读取。

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


为什么要使用Markdown?

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

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

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

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

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

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


开始尝试

Markdown入门的最佳方法是使用它。有了各种免费工具,这比以往任何时候都容易。

您甚至都不需要下载任何内容。您可以使用几种在线Markdown编辑器来尝试在Markdown中编写。本站也提供了Markdown在线编辑器

迹忆客工具--Markdown在线编辑器

阅读本指南时,你可以打开Markdown在线编辑器 。这样,你就可以一边学习 Markdown 语法一边练习了。熟悉 Markdown 之后,再选择一个顺手的 Markdown 的应用程序。


Markdown 工作原理

Dillinger使Markdown的编写变得容易,因为它隐藏了幕后发生的事情,但是值得探索该过程的总体工作方式。

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

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

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

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

markdown工作原理

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

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

从您的角度来看,该过程将根据您使用的应用程序而有所不同。例如,在线 Markdown 编辑器本质上将第1-3步组合到一个无缝的界面中,您要做的就是在左窗格中键入内容,并且呈现的输出神奇地出现在右窗格中。但是,如果您使用其他工具(例如带有静态网站生成器的文本编辑器),则会发现该过程更为可见。


Markdown有什么用处?

Markdown是记笔记,为网站创建内容以及生成可打印文档的快速简便的方法。

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

这是您可以使用Markdown进行操作的一些示例。

网站

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

如果您熟悉HTML,CSS和版本控制,请查看[Jekyll],这是一个受欢迎的静态网站生成器,它使用Markdown文件并构建HTML网站。这种方法的优势之一是GitHub Pages为Jekyll生成的网站提供免费托管。如果Jekyll不是您的理想之选,请选择其他可用的静态站点生成器之一。

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

文件资料

Markdown没有像Microsoft Word这样的文字处理程序的所有功能,但是对于创建基本文件(如作业和字母)已经足够了。您可以使用Markdown文档创作应用程序来创建Markdown格式的文档并将其导出为PDF或HTML文件格式。PDF部分是关键,因为一旦有了PDF文档,您就可以使用它进行任何操作-打印,通过电子邮件发送或将其上传到网站。

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

  • 现代编辑器 VSCode / Atom
  • 传统编辑器 Vim / Emacs / Sublime Text / Notepad++
  • IDE 自带编辑器 IntelliJ IDEA / Android Studio / WebStorm
  • 专用编辑器 Ulysses / Mou / Typora / Markpad

在* 线编辑器 各种支持 Markdown 的网站都提供了在线 Markdown 编辑器

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

笔记

在几乎所有方面,Markdown都是记笔记的理想语法。现在最受欢迎的一款笔记应用程序Evernote也支持Markdown语法。

印象笔记支持Markdown语法

还有一些其他的笔记应用程序也是支持的

  • [Simplenote] 是适用于所有平台的免费、简单的笔记应用程序。
  • [Notable] 是可以在各种平台上运行的笔记应用程序。
  • [Bear] 是适用于 Mac 和 iOS 设备的类似 Evernote 的应用程序。默认情况下,它并不专门针对 Markdown 的,但是你可以启用 Markdown 兼容模式。
  • [Boostnote] 自称是“专为程序员设计的开源笔记应用程序”。

图书

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

演示文稿

信不信由你,您可以从Markdown格式的文件生成演示文稿。在Markdown中创建演示文稿需要一点时间来适应,但是一旦掌握了它,它比使用PowerPoint或Keynote之类的应用程序更快,更容易。Remark(GitHub项目)和Cleaver(GitHub项目)一样,是一种基于浏览器的流行Markdown幻灯片工具。如果您使用的是Mac,并且希望使用某个应用程序,请查看Deckset或Marked。

电子邮件

如果您发送大量电子邮件,并且对大多数电子邮件提供商网站上可用的格式设置控件感到厌倦,那么您将很高兴地发现有一种使用Markdown编写电子邮件的简便方法。Markdown这是一个免费的开放源代码浏览器扩展程序,可将Markdown格式的文本转换为可发送的HTML。

文献资料

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。以下是一些其他介绍性资源:

  • John Gruber的Markdown文档。Markdown的创建者编写的原始指南。
  • MarkDown教程。一个开放源代码的网站,允许您在Web浏览器中尝试Markdown。
  • Awesome Markdown。Markdown工具和学习资源列表。(由于 github网站目前不能稳定打开,所以前面就不做链接了,地址放在后面)地址 https://github.com/mundimark/awesome-markdown
  • 排版Markdown。一个由多个部分组成的系列,介绍了使用pandoc和ConTeXt对Markdown文档进行排版的生态系统。

查看笔记

扫码一下
查看教程更方便