• 1.摘要
  • 2.基本信息
  • 3.基本介绍
  • 4.发展历程
  • 5.常用语法
  • 5.1.标题
  • 5.2.文本样式
  • 5.3.图片
  • 5.4.脚注
  • 5.5.写代码
  • 5.6.例子
  • 6.编辑器
  • 7.参考资料

Markdown

轻量级标记语言

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

由于Markdown的轻量化、易读易写特性,并且对于图片、图表、数学式都有支持,被网站广泛使用来撰写帮助文档或是用于论坛上发表消息1

基本信息

  • 外文名

    Markdown

  • 应用

    文档快速排版

  • 格式

    LaTeXDocbook

  • 宗旨

    易读易写

  • 特点

    轻量简单通用

  • 开发者

    John Gruber

  • 文件后缀名

    .md , .markdown, .mdown

基本介绍

Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。

用于编写说明文档,并且以“README.md”的文件名保存在软件的目录下面。

除此之外,由于我们有了RStudio这样的神级编辑器,我们还可以快速将Markdown转化为演讲PPT、Word产品文档、LaTex论文甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown已经广泛使用,极大地推进了动态可重复性研究的历史进程2

发展历程

John Gruber在2004年创造了Markdown语言,在语法上有很大一部分是跟亚伦·斯沃茨(Aaron Swartz)共同合作的。这个语言的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成有效的XHTML(或是HTML)”。 其中最重要的设计是可读性,也就是说这个语言应该要能直接在字面上的被阅读,而不用被一些格式化指令标记(像是RTF与HTML)。 因此,它是现行电子邮件标记格式的惯例,虽然它也借鉴了很多早期的标记语言,如:Setext、Texile、reStructuredText。

标准化

Markdown已经成为典型的转换为HTML的非正式规范3非正和参考实现。随着时间的推移,出现了许多Markdown实现。人们开发这些主要是由于在基本语法之上需要额外的功能 - 例如表格,脚注,定义列表(技术上的HTML描述列表)和HTML块内的Markdown。其中一些行为偏离了最开始的参考实现。与此同时,非正式规范中的一些含糊不清引起了人们的注意 4。这些问题促使Markdown解析器的一些开发人员努力实现标准化。

2016年3月发布了RFC 7763和RFC 7764。RFC 7763 从原始变体引入了MIME类型 text/markdown。RFC 7764讨论并注册了MultiMarkdown、GitHub Flavored Markdown (GFM)、Pandoc、CommonMark及Markdown等变体5

CommonMark

从2012年开始,包括Jeff Atwood和John MacFarlane在内的一群人启动了标准化工作6。一个社区网站旨在记录可用于文档作者和开发人员的各种工具和资源,以及各种markdown实现的实现者7。2014年9月,Gruber反对在这一工作中继续使用“Markdown”这个名字,其被更名为CommonMark8。 CommonMark发布了规范、参考实现和测试包的几个版本,并计划在2018年宣布最终的1.0规范和测试包9

GFM

2017年,GitHub发布了基于CommonMark的GitHub Flavored Markdown(GFM)的正式规范10。除了表格、删除线、自动链接和任务列表被GitHub规范作为扩展添加之外,它遵循CommonMark规范。GitHub还相应地更改了其站点上使用的解析器,这要求更改某些文档 - 例如,GFM要求创建标题的哈希符号由空格字符分隔。

常用语法

最常见的Markdown格式选项和键盘快捷键:

输出后的效果

Markdown

快捷键

Bold

**text**

Ctrl/⌘ + B

Emphasize

*text*

Ctrl/⌘ + I

Link

[title](http://)

Ctrl/⌘ + K

Inline Code

`code`

Ctrl/⌘ + Shift + K

Image

![alt](http://)

Ctrl/⌘ + Shift + I

标题

标题能显示出文章的结构。行首插入1-6个 # ,每增加一个 # 表示更深入层次的内容,对应到标题的深度由 1-6 阶。

  • H1 :# Header 1

  • H2 :## Header 2

  • H3 :### Header 3

  • H4 :#### Header 4

  • H5 :##### Header 5

  • H6 :###### Header 6