Markdown

Markdown

Filename extension	.md, .markdown
Internet media type	text/markdown
Uniform Type Identifier (UTI)	net.daringfireball.markdown
Developed by	John Gruber
Initial release	March 25, 2004 (2004-03-25)
Latest release	1.0.1 December 17, 2004 (2004-12-17)
Type of format	Markup language
Free format?	yes
Website	daringfireball.net/projects/markdown/

Markdown is a plain text formatting syntax designed so that it optionally can be converted to HTML using a tool by the same name. Markdown is popularly used to format readme files, for writing messages in online discussion forums or in text editors for the quick creation of rich text documents.

History

The Markdown language was created in 2004 by John Gruber with substantial contributions from Aaron Swartz, with the goal of allowing people “to write using an easy-to-read, easy-to-write plain text format, and optionally convert it to structurally valid XHTML (or HTML)”.

Taking cues from existing conventions for marking up plain text in email such as setext, the language was designed to be readable as-is, without looking like it's been marked up with tags or formatting instructions, unlike text formatted with a Markup language, such as HTML, which has obvious tags and formatting instructions. Markdown is a formatting syntax for text that can be read by humans and can be easily converted to HTML.

Gruber wrote a Perl script, Markdown.pl, which converts marked-up text input to valid, well-formed XHTML or HTML and replaces left-pointing angle brackets ('<') and ampersands with their corresponding character entity references. It can be used as a standalone script, as a plugin for Blosxom or Movable Type, or as a text filter for BBEdit.

Markdown has since been re-implemented by others as a Perl module available on CPAN (Text::Markdown), and in a variety of other programming languages. It is distributed under a BSD-style license and is included with, or available as a plugin for, several content-management systems.

Sites such as GitHub, reddit, Diaspora, Stack Exchange, OpenStreetMap, and SourceForge use variants of Markdown to facilitate discussion between users.

Standardization

There is no clearly defined Markdown standard, apart from the original writeup and implementation by John Gruber, which some consider to be abandonware. This has led to fragmentation as different vendors write their own variants of the language to correct flaws or add missing features.

From 2012 through 2014, a group of people including Jeff Atwood launched what Atwood characterized as a standardization effort. 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". In September 2014, Gruber objected to the usage of "Markdown" in the name of this effort and it was rebranded as a new dialect named "CommonMark".

A tool (named Babelmark2) is also available to "[compare] the output of various implementations" to "promote discussion of how and whether certain vague aspects of the markdown spec should be clarified". Gruber has argued that complete standardisation would be mistaken: "Different sites (and people) have different needs. No one syntax would make all happy."

A standards effort for the Internet media type text/markdown (independent of the syntax) is underway in the IETF. The Internet-Draft, draft-ietf-appsawg-text-markdown, is planned to be submitted to the IESG in April 2015. The Markdown community is invited to submit use cases for Markdown, which will inform the media type standardization process.

Extensions

A number of lightweight markup languages extend Markdown by implementing added features (such as tables, footnotes, definition lists, and Markdown inside HTML blocks) not available with plain Markdown syntax. Among these are Markdown Extra, MultiMarkdown, Maruku, Kramdown and the Pandoc Markdown extension. In some cases, this is in order to enable conversion into more formats than HTML, e.g. LaTeX, RTF and DocBook.

Many implementations also intentionally omit support for middle word emphasis. The original Markdown implementation interprets constructs like my_long_variable as a request to emphasize "long" in the middle of a word. Many users found this confusing, so many later implementations such as PHP Markdown and Python Markdown do not implement middle word emphasis by default.

The essay "Thoughts on Markdown" stated that Markdown's original developer, John Gruber, has not responded to discussions about extensions to Markdown, and that "Markdown is changing, with or without him".

Example

The following shows text using Markdown syntax on the left, the corresponding HTML produced by a Markdown processor in the center, and the text viewed in a browser on the right.

Heading ======= Sub-heading ----------- h3. Traditional html title Paragraphs are separated by a blank line. Let 2 spaces at the end of a line to do a line break Text attributes *italic*, **bold**, `monospace`. A [link](http://example.com). <<< No space between ] and ( >>> Shopping list: * apples * oranges * pears Numbered list: 1. apples 2. oranges 3. pears The rain---not the reign---in Spain.

<h1>Heading</h1> <h2>Sub-heading</h2> <h3>Traditional html title</h3> <p>Paragraphs are separated by a blank line.</p> <p>Let 2 spaces at the end of a line to do a<br /> line break</p> <p>Text attributes <em>italic</em>, <strong>bold</strong>, <code>monospace</code>.</p> <p>A <a href="http://example.com">link</a>.</p> <p>Shopping list:</p> <ul> <li>apples</li> <li>oranges</li> <li>pears</li> </ul> <p>Numbered list:</p> <ol> <li>apples</li> <li>oranges</li> <li>pears</li> </ol> <p>The rain&mdash;not the reign&mdash;in Spain.</p>

Paragraphs are separated by a blank line. Let 2 spaces at the end of a line to do a line break Text attributes italic, bold, monospace. A link. Shopping list: apples oranges pears Numbered list: apples oranges pears The rain—not the reign—in Spain.

Editors

While Markdown is a minimal markup language and is easily read and edited with a normal text editor, there are specially-designed editors that preview the files with styles. There are a variety of such editors available for all major platforms; one such graphical editor for Windows is MarkdownPad. There are syntax highlighting plugins for Markdown built into emacs, gedit, and vim.

Implementations

Implementations of Markdown are available for many different frameworks, platforms and languages.

• The sourcecode documentation generator Doxygen supports Markdown with extra features.
• RStudio, an IDE for R provides a C++ wrapper function for the markdown implementation sundown.
• IntelliJ IDEA, an IDE for Java, provides a Markdown plugin
• MultiMarkdown, a format and program with more syntax features and export options than traditional Markdown
• PageDown, a parser for StackExchange's Markdown syntax
• GitHub Flavored Markdown (GFM) adds syntax highlighting, task lists, and tables. It has several implementations:
  • ""Grip - Github Readme Instant Preview" (Joe Esposito) - Python
  • "Vim-Flavored-Markdown" (Jeff Tratner) - Vim scripting
  • "GitHub-Flavored Markdown Comments" (Evan Solomon) - PHP WordPress plugin
  • "Markdown on Save" (Mark Jaquith) - PHP WordPress plugin
  • "Node-GFM" (Gabriel Llamas) - JavaScript
  • "Parsedown" (Emanuil Rusev) - PHP
• Pandoc adds tables, line blocks, definition lists, superscripts and subscripts, can generate table of content.

Test Suites

• Markdown Test suite

There are many more open-source implementations of Markdown available online.

See also

• Similar lightweight markup languages:
  • AsciiDoc, supports many document types
  • Org-mode
  • reStructuredText, used for Python documentation
  • Setext, from 1992
  • Textile
  • txt2tags
• Comparison of document markup languages
• Comparison of documentation generators

External links

• Official Markdown project at Daring Fireball
• A Markdown community page
• W3C's Markdown Community Group
• A Markdown parser and compiler, written in JavaScript