Markdown

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Markdown
Markdown-mark.svg
Internet media type text/markdown[1]
Uniform Type Identifier (UTI) net.daringfireball.markdown
Developed by John Gruber
Initial release March 19, 2004 (14 years ago) (2004-03-19)[2][3]
Latest release
1.0.1
(December 17, 2004 (13 years ago) (2004-12-17)[4])
Type of format Markup language
Extended to MultiMarkdown, Markdown Extra, CommonMark[5]
Open format? yes[6]
Website daringfireball.net/projects/markdown

Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name.[8] Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. As the initial description of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown appeared over the years to answer these issues.

History[edit]

John Gruber created the Markdown language in 2004 in collaboration with Aaron Swartz on the syntax,[2][3] with the goal of enabling people "to write using an easy-to-read and easy-to-write plain text format, optionally convert it to structurally valid XHTML (or HTML)".[4]

The key design goal is 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 a markup language, such as Rich Text Format (RTF) or HTML, which have obvious tags and formatting instructions. To this end, its main inspiration is the existing conventions for marking up plain text in email, though it also draws from earlier markup languages, notably setext, Textile, and reStructuredText.[9]

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 be used as a standalone script, as a plugin for Blosxom or Movable Type, or as a text filter for BBEdit.[4]

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.[10] It is distributed under a BSD-style license and is included with, or available as a plugin for, several content-management systems.[6][11][12]

Sites such as GitHub, Bitbucket, Reddit, Diaspora, Stack Exchange, OpenStreetMap, and SourceForge use variants of Markdown to facilitate discussion between users.[13][14][15][16]

Standardization[edit]

Markdown has been characterised by an informal specification[17] and a reference implementation for conversion to HTML. Over time, many Markdown implementations have appeared. People developed these mostly driven by the need for additional features on top of the base syntax—such as tables, footnotes, definition lists, and Markdown inside HTML blocks. The behavior of some of these diverges from the reference implementation. At the same time, a number of ambiguities in the informal specification have attracted attention[18]. These issues spurred an effort by some developers of Markdown parsers for standardisation.

Babelmark[19] are tools 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."[20] Gruber has argued that complete standardization would be mistaken: "Different sites (and people) have different needs. No one syntax would make all happy."[21]

In March 2016 RFC 7763 and RFC 7764 were published. RFC 7763 introduced MIME type text/markdown with the original variant. RFC 7764 discusses and registered the variants MultiMarkdown, GitHub Flavored Markdown (GFM), Pandoc, CommonMark, and Markdown Extra among others.[22]

CommonMark[edit]

CommonMark
Markdown-mark.svg
Filename extensions .md, .markdown[1]
Internet media type text/markdown; variant=CommonMark[5]
Uniform Type Identifier (UTI) uncertain[23]
UTI conformation public.plain-text
Developed by John MacFarlane, open source
Initial release October 25, 2014 (3 years ago) (2014-10-25)
Latest release
0.28
(August 1, 2017 (13 months ago) (2017-08-01)[24])
Type of format Markup language
Extended from Markdown
Extended to GitHub Flavored Markdown
Open format? yes
Website spec.commonmark.org

From 2012, a group of people including Jeff Atwood and John MacFarlane launched what Atwood characterized as a standardization effort.[25] 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".[26] 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.[27][28] CommonMark.org published several versions of a specification, reference implementation, and test suite, and "[plans] to announce a finalized 1.0 spec and test suite in 2018."[29]

GFM[edit]

In 2017, GitHub released a formal specification of their GitHub Flavored Markdown (GFM) that is based on CommonMark.[30] It follows the CommonMark specification exactly except for tables, strikethrough, autolinks and task lists, which the GitHub spec has added as extensions[31]. GitHub also changed the parser used on their sites accordingly, which required that some documents be changed—e.g., it now requires a space after the hash signs of a heading.

Markdown Extra[edit]

Markdown Extra is a lightweight markup language based on Markdown implemented in PHP (originally), Python and Ruby. It adds features not available with plain Markdown syntax. Markdown Extra is supported in content management systems, for example Drupal,[32] TYPO3[33] and MediaWiki.[34]

It adds the following features to Markdown:

  • Markdown inside HTML blocks
  • Elements with id/class attribute
  • Fenced code blocks
  • Tables[35]
  • Definition lists
  • Footnotes
  • Abbreviations

Example[edit]

Text using Markdown syntax Corresponding HTML produced by a Markdown processor Text viewed in a browser
Heading
=======

## Sub-heading

Paragraphs are separated
by a blank line.

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

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

Horizontal rule:

---

Bullet list:

  * apples
  * oranges
  * pears

Numbered list:

  1. wash
  2. rinse
  3. repeat

A [link][example].

  [example]: http://example.com

![Image](Image_icon.png "icon")

> Markdown uses email-style > characters for blockquoting.

Inline <abbr title="Hypertext Markup Language">HTML</abbr> is supported.
<h1>Heading</h1>

<h2>Sub-heading</h2>

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

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

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

<p>Horizontal rule:</p>

<hr />

<p>Bullet list:</p>

<ul>
<li>apples</li>
<li>oranges</li>
<li>pears</li>
</ul>

<p>Numbered list:</p>

<ol>
<li>wash</li>
<li>rinse</li>
<li>repeat</li>
</ol>

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

<p><img alt="Image" title="icon" src="Image_icon.png" /></p>

<blockquote>
<p>Markdown uses email-style &gt; characters for blockquoting.</p>
</blockquote>

<p>Inline <abbr title="Hypertext Markup Language">HTML</abbr> is supported.</p>
Heading
Sub-heading

Paragraphs are separated by a blank line.

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

Text attributes italic, bold, monospace.

Horizontal rule:


Bullet list:

  • apples
  • oranges
  • pears

Numbered list:

  1. wash
  2. rinse
  3. repeat

A link.

title=icon

Markdown uses email-style > characters for blockquoting.

Inline HTML is supported.

Implementations[edit]

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

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.

  • The sourcecode documentation generator Doxygen supports Markdown with extra features.[38]
  • RStudio, an IDE for R provides a C++ wrapper function for a markdown variant called sundown.[39]
  • GitHub Flavored Markdown (GFM) ignores underscores in words, and adds syntax highlighting, task lists,[40] and tables.[41]
  • Discount - a C implementation.[42][43]
  • MarkAPL is a converter written in Dyalog APL. It supports fenced blocks, smart typography, link references, and special attributes, and can generate a table of contents.[44]
  • PHP Markdown - a library package that includes the PHP Markdown parser and its sibling PHP Markdown Extra with additional features.[45]
  • Markdig - A .NET library that follows the CommonMark specifications, and includes a collection of extensions and the ability for the user to create their own.

See also[edit]

References[edit]

  1. ^ a b c RFC 7763 - The text/markdown Media Type
  2. ^ a b Swartz, Aaron (2004-03-19). "Markdown". Aaron Swartz: The Weblog.
  3. ^ a b Gruber, John. "Daring Fireball: Markdown". Daring Fireball. Archived from the original on 2004-04-02. Retrieved 2014-04-25.
  4. ^ a b c Markdown 1.0.1 readme source code "Daring Fireball – Markdown". 2004-12-17. Archived from the original on 2004-04-02.
  5. ^ a b RFC7764 – Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations
  6. ^ a b "Markdown: License". Daring Fireball. Retrieved 2014-04-25.
  7. ^ Daring Fireball statement by creator John Gruber
  8. ^ "Markdown". 2013-12-04. Archived from the original on 2004-04-02.
  9. ^ a b Markdown Syntax "Daring Fireball – Markdown – Syntax". 2013-06-13. Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters — including Setext, atx, Textile, reStructuredText, Grutatext, and EtText — the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
  10. ^ "Markdown 2.6.6". Python Software Foundation. 2016-03-21. Retrieved 2016-07-06.
  11. ^ "MarsEdit 2.3 ties the knot with Tumblr support – Ars Technica". Retrieved 2009-08-11.
  12. ^ "Review: Practical Django Projects – Ars Technica". Retrieved 2009-08-11.
  13. ^ "GitHub Flavored Markdown". GitHub. Retrieved 2013-03-29.
  14. ^ "Reddit markdown primer. Or, how do you do all that fancy formatting in your comments, anyway?". Reddit.com. Retrieved 2013-03-29.
  15. ^ "Markdown Editing Help". StackOverflow.com. Retrieved 2014-04-11.
  16. ^ "SourceForge: Markdown Syntax Guide". SourceForge.net. Retrieved 2013-05-10.
  17. ^ https://daringfireball.net/projects/markdown/syntax
  18. ^ See, for example, https://github.github.com/gfm/#why-is-a-spec-needed-
  19. ^ "Babelmark 2 - Compare markdown implementations". Johnmacfarlane.net. Retrieved 2014-04-25. "Babelmark 3 - Compare Markdown Implementations". github.io. Retrieved 2017-12-10.
  20. ^ "Babelmark 2 - FAQ". Johnmacfarlane.net. Retrieved 2014-04-25.
  21. ^ Gruber, John [@gruber] (4 September 2014). "@tobie @espadrine @comex @wycats Because different sites (and people) have different needs. No one syntax would make all happy" (Tweet) – via Twitter.
  22. ^ "Markdown Variants". IANA. 2016-03-28. Retrieved 2016-07-06.
  23. ^ "UTI of a CommonMark document".
  24. ^ "CommonMark specification".
  25. ^ Atwood, Jeff (2012-10-25). "The Future of Markdown". CodingHorror.com. Retrieved 2014-04-25.
  26. ^ "Markdown Community Page". GitHub. Retrieved 2014-04-25.
  27. ^ "Standard Markdown is now Common Markdown". Jeff Atwood. Retrieved 2014-10-07.
  28. ^ "Standard Markdown Becomes Common Markdown then CommonMark". InfoQ. Retrieved 2014-10-07.
  29. ^ "CommonMark". Retrieved 20 Jun 2018. The current version of the CommonMark spec is complete, and quite robust after a year of public feedback … but not quite final. With your help, we plan to announce a finalized 1.0 spec and test suite in 2018.
  30. ^ "GitHub Flavored Markdown Spec".
  31. ^ "A formal spec for GitHub Flavored Markdown". GitHub Engineering. Retrieved 16 Mar 2017.
  32. ^ Markdown editor for BUEditor
  33. ^ Markdown for TYPO3
  34. ^ MarkdownExtraParser for MediaWiki
  35. ^ PHP Markdown Extra - Tables
  36. ^ "W3C Community Page of Markdown Implementations". W3C Markdown Wiki. Retrieved 24 March 2016.
  37. ^ "Markdown THrowdown – What happens when FOSS software gets corporate backing". Ars Technica. 2014-10-05.
  38. ^ "Doxygen Manual: Markdown support". Stack.nl. 2014-04-21. Retrieved 2014-04-25.
  39. ^ jjallaire; e.a. (2015-06-30). "Markdown.cpp". GitHub project RStudio. Retrieved 2016-07-07.
  40. ^ "Writing on GitHub". help.github.com. GitHub, Inc. Retrieved 9 July 2014.
  41. ^ "GitHub Flavored Markdown". github.com. Retrieved 29 March 2013.
  42. ^ "Discount - a C implementation of the Markdown markup language". Retrieved 2014-11-01.
  43. ^ David Parsons (2016-05-28). "DISCOUNT". GitHub. Retrieved 2016-07-07. discount at Open Hub
  44. ^ "Markdown converter written in Dyalog APL".
  45. ^ "PHP Markdown". Retrieved 2016-03-01.

External links[edit]