Markdown

Markdown

Filename extensions	.md, .markdown[1][2]
Internet media type	text/markdown[2]
Uniform Type Identifier (UTI)	net.daringfireball.markdown
Developed by	John Gruber
Initial release	March 9, 2004 (20 years ago) (2004-03-09)[3][4]
Latest release	1.0.1 December 17, 2004 (19 years ago) (2004-12-17)[5]
Type of format	Open file format[6]
Extended to	pandoc, MultiMarkdown, Markdown Extra, CommonMark,[7] RMarkdown[8]
Website	daringfireball.net/projects/markdown/

Markdown^[9] is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber created Markdown in 2004 as an easy-to-read markup language.^[9] Markdown is widely used for blogging and instant messaging, and also used elsewhere in online forums, collaborative software, documentation pages, and readme files.

The initial description of Markdown^[10] contained ambiguities and raised unanswered questions, causing implementations to both intentionally and accidentally diverge from the original version. This was addressed in 2014 when long-standing Markdown contributors released CommonMark, an unambiguous specification and test suite for Markdown.^[11]

Markdown was inspired by pre-existing conventions for marking up plain text in email and usenet posts,^[12] such as the earlier markup languages setext (c. 1992), Textile (c. 2002), and reStructuredText (c. 2002).^[9]

In 2002 Aaron Swartz created atx and referred to it as "the true structured text format". Gruber created the Markdown language in 2004 with Swartz as his "sounding board".^[13] The goal of the language was to enable people "to write using an easy-to-read and easy-to-write plain text format, optionally convert it to structurally valid XHTML (or HTML)".^[5]

Another key design goal was readability, that the language be readable as-is, without looking like it has been marked up with tags or formatting instructions,^[9] unlike text formatted with "heavier" markup languages, such as Rich Text Format (RTF), HTML, or even wikitext (each of which have obvious in-line tags and formatting instructions which can make the text more difficult for humans to read).

Gruber wrote a Perl script, Markdown.pl, which converts marked-up text input to valid, well-formed XHTML or HTML and replaces angle brackets (<, >) and ampersands (&) with their corresponding character entity references. It can take the role of a standalone script, a plugin for Blosxom or a Movable Type, or of a text filter for BBEdit.^[5]

As Markdown's popularity grew rapidly, many Markdown implementations appeared, driven mostly by the need for additional features such as tables, footnotes, definition lists,^{[note 1]} and Markdown inside HTML blocks.

The behavior of some of these diverged from the reference implementation, as Markdown was only characterised by an informal specification^[16] and a Perl implementation for conversion to HTML.

At the same time, a number of ambiguities in the informal specification had attracted attention.^[17] These issues spurred the creation of tools such as Babelmark^[18][19] to compare the output of various implementations,^[20] and an effort by some developers of Markdown parsers for standardisation. However, Gruber has argued that complete standardization would be a mistake: "Different sites (and people) have different needs. No one syntax would make all happy."^[21]

Gruber avoided using curly braces in Markdown to unofficially reserve them for implementation-specific extensions.^[22]

CommonMark

Filename extensions	.md, .markdown[2]
Internet media type	text/markdown; variant=CommonMark[7]
Uniform Type Identifier (UTI)	uncertain[23]
UTI conformation	public.plain-text
Developed by	John MacFarlane, open source
Initial release	October 25, 2014 (10 years ago) (2014-10-25)
Latest release	0.31.2 January 28, 2024 (10 months ago) (2024-01-28)[24]
Type of format	Open file format
Extended from	Markdown
Extended to	GitHub Flavored Markdown
Website	commonmark.org spec.commonmark.org

From 2012, a group of people, including Jeff Atwood and John MacFarlane, launched what Atwood characterised as a standardisation effort.^[11]

A community website now aims to "document various tools and resources available to document authors and developers, as well as implementors of the various Markdown implementations".^[25]

In September 2014, Gruber objected to the usage of "Markdown" in the name of this effort and it was rebranded as CommonMark.^[12][26][27] CommonMark.org published several versions of a specification, reference implementation, test suite, and "[plans] to announce a finalized 1.0 spec and test suite in 2019".^[28]

No 1.0 spec has since been released, as major issues still remain unsolved.^[29]

Nonetheless, the following websites and projects have adopted CommonMark: Discourse, GitHub, GitLab, Reddit, Qt, Stack Exchange (Stack Overflow), and Swift.

In March 2016, two relevant informational Internet RFCs were published:

• RFC 7763 introduced MIME type text/markdown.
• RFC 7764 discussed and registered the variants MultiMarkdown, GitHub Flavored Markdown (GFM), Pandoc, and Markdown Extra among others.^[30]

Websites like Bitbucket, Diaspora, GitHub,^[31] OpenStreetMap, Reddit,^[32] SourceForge^[33] and Stack Exchange^[34] use variants of Markdown to make discussions between users easier.

Depending on implementation, basic inline HTML tags may be supported.^[35]

Italic text may be implemented by _underscores_ or *single-asterisks*.^[36]

GitHub had been using its own variant of Markdown since as early as 2009,^[37] which added support for additional formatting such as tables and nesting block content inside list elements, as well as GitHub-specific features such as auto-linking references to commits, issues, usernames, etc.

In 2017, GitHub released a formal specification of its GitHub Flavored Markdown (GFM) that is based on CommonMark.^[31] It is a strict superset of CommonMark, following its specification exactly except for tables, strikethrough, autolinks and task lists, which GFM adds as extensions.^[38]

Accordingly, GitHub also changed the parser used on their sites, which required that some documents be changed. For instance, GFM now requires that the hash symbol that creates a heading be separated from the heading text by a space character.

Markdown Extra is a lightweight markup language based on Markdown implemented in PHP (originally), Python and Ruby.^[39] It adds the following features that are not available with regular Markdown:

• Markdown markup inside HTML blocks
• Elements with id/class attribute
• "Fenced code blocks" that span multiple lines of code
• Tables^[40]
• Definition lists
• Footnotes
• Abbreviations

Markdown Extra is supported in some content management systems such as Drupal,^[41] Grav (CMS) and TYPO3.^[42]

LiaScript^[43] is a Markdown dialect that was designed to create interactive educational content. It is implemented in Elm and TypeScript and adds additional syntax elements to define features like:

• Animations
• Automatic speech output
• Mathematical formulas (using KaTeX)
• ASCII art diagrams
• Various types of quizzes and surveys
• JavaScript is natively supported and can be attached to various elements, this way code fragments can be made executable and editable

Heading
=======

Sub-heading
-----------

# Alternative heading

## Alternative sub-heading

Paragraphs are separated 
by a blank line.

Two spaces at the end of a line  
produce a line break.

<h1>Heading</h1>

<h2>Sub-heading</h2>

<h1>Alternative heading</h1>

<h2>Alternative sub-heading</h2>

<p>Paragraphs are separated
by a blank line.</p>

<p>Two spaces at the end of a line<br />
produce a line break.</p>

Text attributes _italic_, **bold**, `monospace`.

Horizontal rule:

---

<p>Text attributes <em>italic</em>, <strong>bold</strong>, <code>monospace</code>.</p>

<p>Horizontal rule:</p>

<hr />

Bullet lists nested within numbered list:

  1. fruits
     * apple
     * banana
  2. vegetables
     - carrot
     - broccoli

<p>Bullet lists nested within numbered list:</p>

<ol>
  <li>fruits <ul>
      <li>apple</li>
      <li>banana</li>
  </ul></li>
  <li>vegetables <ul>
      <li>carrot</li>
      <li>broccoli</li>
  </ul></li>
</ol>

A [link](http://example.com).

![Image](Icon-pictures.png "icon")

> Markdown uses email-style
characters for blockquoting.
>
> Multiple paragraphs need to be prepended individually.

Most inline <abbr title="Hypertext Markup Language">HTML</abbr> tags are supported.

<p>A <a href="http://example.com">link</a>.</p>

<p><img alt="Image" title="icon" src="Icon-pictures.png" /></p>

<blockquote>
<p>Markdown uses email-style characters for blockquoting.</p>
<p>Multiple paragraphs need to be prepended individually.</p>
</blockquote>

<p>Most inline <abbr title="Hypertext Markup Language">HTML</abbr> tags are supported.</p>

Implementations of Markdown are available for over a dozen programming languages; in addition, many applications, platforms and frameworks support Markdown.^[44] For example, Markdown plugins exist for every major blogging platform.^[12]

While Markdown is a minimal markup language and is read and edited with a normal text editor, there are specially designed editors that preview the files with styles, which are available for all major platforms. Many general-purpose text and code editors have syntax highlighting plugins for Markdown built into them or available as optional download. Editors may feature a side-by-side preview window or render the code directly in a WYSIWYG fashion.

Some apps, services and editors support Markdown as an editing format, including:

• Bugzilla uses a customized version of Markdown.^[45]
• ChatGPT: Output from the LLM formatted in Markdown will be rendered in LaTeX and HTML by the ChatGPT client, and the model is encouraged to use Markdown to format its output. Markdown provided by the user will not be formatted by the client, but will still be passed to the model unaltered.
• Discord: chat messages^[46]
• Discourse uses the CommonMark flavor of Markdown in the forum post composer.
• Doxygen: a source code documentation generator which supports Markdown with extra features^[47]
• GitHub Flavored Markdown (GFM) ignores underscores in words, and adds syntax highlighting, task lists,^[48] and tables^[31]
• The GNOME Evolution email client supports composing messages in Markdown format,^[49] with the ability to send and render emails in pure Markdown format (Content-Type: text/markdown;) or to convert Markdown to plaintext or HTML email when sending.
• Joplin: a note-taking application that supports markdown formatting^[50]
• JotterPad: an online WYSIWYG editor that supports Markdown and Fountain^[51]
• Kanboard uses the standard Markdown syntax as its only formatting syntax for task descriptions.^[52]
• Microsoft Azure DevOps' wiki feature supports both common Markdown conventions and GitHub Flavored Markdown^[53]
• Microsoft Teams: chat messages^[54]
• Misskey, its numerous forks and other Fediverse platforms such as Akkoma^[55] use a custom text format misleadingly called "Misskey-Flavored Markdown (MFM)", with support for standard nestable block quotes > and inline emphasis _*` as well as extensions seen elsewhere for @ mentions, # tags, custom emoji :foo:, automatic URL detection and toggleable link target preview, but no support for headings, lists, reference links and other standard Markdown features. It supports a handful of HTML-like tags (<small> <center> <plain>) and a special notation with English keywords or key-value pairs $[key=value content] for spans with stylistic effects applied, e.g. fonts, blurs, borders and transformations such as flipping, shifting, rotating, scaling and animation, but also for furigana and search boxes.^[56] The message format of such ActivityPub objects that can be consumed as messages is text/x.misskeymarkdown.
• The Mozilla Thunderbird email client supports Markdown through the "Markdown here Revival" add-on.
• Nextcloud Notes: the default app for taking notes on the Nextcloud platform supports formatting using Markdown^[57]
• Obsidian is note-taking software based on Markdown files.^[58]
• RMarkdown^[59]
• RStudio: an IDE for R. It provides a C++ wrapper function for a markdown variant called sundown^[60]
• Simplenote^[61]

• Comparison of document markup languages
• Comparison of documentation generators
• Lightweight markup language
• Wiki markup

• Official website for original John Gruber markup