一、Markdown概述
Markdown是一种轻量级标记语言,可用于向明文文本文档添加格式元素。于2004年由John Gruber创建。
Markdown与Microsoft Word等WYSIWYG(所见即所得)编辑器不同:
在Microsoft Word等应用程序中,单击按钮可以设置单词和短语的格式,并且可以立即看到更改。而编辑Markdown格式的文件时,需要在文本中添加Markdown语法,以指示哪些单词和短语应该看起来不同。
当然你也可以通过使用可实时渲染的Markdown应用程序,实时地看到你的编辑效果。如以下MarkdownPad 2编辑器中的markdown文件效果:
即使所使用的应用程序不能实时预览也没有关系。The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible ,因此Markdown文件中的文本即使没有呈现也可以被读取。
二、Markdown是如何工作的
实时预览的各种应用程序使得markdown文件编辑变得简单,包括将其.md或.markdown扩展名的文件转换为HTML或者pdf等,其背后的工作原理是什么呢?
这是一个由四部分组成的过程
- 创建.md扩展名文件
- 在Markdown应用程序打开文件
- Markdown应用程序中的Markdown处理器将文件处理,转换成HTML或pdf等可打印文档
- 在Web浏览器或其他应用程序中查看
Markdown处理器(processor)通常也称为“解析器(parser)”或“实现器(implementation)”。
三、Markdown用在什么地方
1、创建网站
Markdown是专为web设计的,因此有大量专门使用Markdown创建网站内容的应用程序。
如blot.im和smallvictori.es。注册其中一个服务后,他们会在您的计算机上创建一个Dropbox文件,只需将Markdown文件拖放到文件夹中即可。
如果熟悉HTML,CSS和版本控制,可使用Jekyll,这是一个流行的静态站点生成器,可以获取Markdown文件并构建HTML网站。这种方法的一个优点是GitHub Pages为Jekyll生成的网站提供免费托管。附上使用指南,来源见出处。
如果你的网站使用WordPress托管,可以使用Jetpack插件。
2、文档编辑
使用Markdown语言编辑基本文档的好处不多说,可自行查阅。
以下是推荐的Markdown文档创作应用程序:
- Mac: iA Writer,Ulysses,Marked或MacDown
- iOS / Android: iA Writer或Ulysses(仅限iOS)
- Windows: MarkdownPad(专业版要付费)
- Web: Dillinger或StackEdit
由文档编辑引出子用途:
(1)在微信公众号文章、电子邮件等不支持markdown的地方,使用Markdown Here插件一键排版你的md文档。附上使用教程:【Markdown】使用Markdown Here插件一键排版md文件
(2)用于记笔记(Evernote目前也支持markdown)
(3)文学创作。尝试Leanpub,Leanpub将你用Markdown写的作品以PDF,EPUB和MOBI文件格式输出。
(4)你可以从这里了解将你Markdown格式的文件生成演示文稿。
此外,Markdown非常适合技术文档。比如GitHub越来越多地转向Markdown的文档 (查看他们的博客,了解他们如何将他们的Markdown格式文档迁移到Jekyll)。如果你为产品或服务编写文档,请查看这些方便的工具:
- Read the Docs可以从你的开源Markdown文件生成文档网站。只需将你的GitHub存储库连接到他们的服务并推送
- MkDocs是一个快速而简单的静态站点生成器,旨在构建项目文档。文档源文件使用Markdown编写,并使用单个YAML配置文件进行配置。MkDocs有几个内置主题,包括用于MkDocs的 Read the Docs文档主题的端口。其中一个最新的主题是 MkDocs Material
- Docusaurus是一个专门用于创建文档网站的静态站点生成器。它支持翻译,搜索和版本控制
- VuePress是一个静态站点生成器,由 Vue提供支持,并针对编写技术文档进行了优化
- Jekyll 也是从Markdown文件生成文档网站的一个很好的选择。查看 Jekyll文档主题
本学习笔记参考资料Markdown指南等。