Markdown

From Wikipedia, the free encyclopedia - View original article

Markdown
Markdown-mark.svg
Filename extension.md, .markdown[1]
Uniform Type Identifiernet.daringfireball.markdown
Developed byJohn Gruber
Initial releaseMarch 25, 2004; 10 years ago (2004-03-25)[2]
Latest release1.0.1 / December 17, 2004; 9 years ago (2004-12-17)[3]
Type of formatMarkup language
Open format?yes[4]
Websitedaringfireball.net/projects/markdown/
 
Jump to: navigation, search
Markdown
Markdown-mark.svg
Filename extension.md, .markdown[1]
Uniform Type Identifiernet.daringfireball.markdown
Developed byJohn Gruber
Initial releaseMarch 25, 2004; 10 years ago (2004-03-25)[2]
Latest release1.0.1 / December 17, 2004; 9 years ago (2004-12-17)[3]
Type of formatMarkup language
Open format?yes[4]
Websitedaringfireball.net/projects/markdown/

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

History[edit]

The Markdown language was created in 2004 by John Gruber with substantial contributions from Aaron Swartz,[6] 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)”.[3]

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,[7] unlike text which has been 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.[3]

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[4] and is included with, or available as a plugin for, several content-management systems.[8][9]

Sites such as GitHub, reddit, Diaspora, Stack Overflow, OpenStreetMap, and SourceForge use variants of Markdown to facilitate discussion between users.[10][11][12][13]

Standardization[edit]

There is no clearly defined Markdown standard, apart from the original writeup and implementation by John Gruber, which is considered to be abandonware,[14][15] leading to fragmentation as different vendors write their own variants of the language to correct flaws or add missing features. In late 2012, a standardization effort was started, spurred in part by a blog post of Jeff Atwood.[16] 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".[17] A tool (named Babelmark2[18]) 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".[19]

Example[edit]

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  -----------    Paragraphs are separated  by a blank line.    Text attributes *italic*,  **bold**, `monospace`.    A [link](http://example.com).    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>   <p>Paragraphs are separated by a blank line.</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> 

Heading

Sub-heading

Paragraphs are separated by a blank line.

Text attributes italic, bold, monospace.

A link.

Shopping list:

  • apples
  • oranges
  • pears

Numbered list:

  1. apples
  2. oranges
  3. pears

The rain—not the reign—in Spain.

Editors[edit]

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

Implementations[edit]

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

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

See also[edit]

References[edit]

  1. ^ Daring Fireball Statement by creator John Gruber
  2. ^ http://web.archive.org/web/20040402182332/http://daringfireball.net/projects/markdown/
  3. ^ a b c Markdown 1.0.1 readme source code "Daring Fireball – Markdown". 17 Dec 2004. 
  4. ^ a b http://daringfireball.net/projects/markdown/license
  5. ^ "Markdown". December 04, 2013 CET. 
  6. ^ "Markdown". Aaron Swartz: The Weblog. March 19, 2004. 
  7. ^ Markdown Syntax "Daring Fireball – Markdown – Syntax". 13 Jun 2013. 
  8. ^ "MarsEdit 2.3 ties the knot with Tumblr support – Ars Technica". Retrieved 2009-08-11. 
  9. ^ "Review: Practical Django Projects – Ars Technica". Retrieved 2009-08-11. 
  10. ^ a b "GitHub Flavored Markdown". github.com. Retrieved 29 March 2013. 
  11. ^ "Reddit markdown primer. Or, how do you do all that fancy formatting in your comments, anyway?". reddit.com. Retrieved 29 March 2013. 
  12. ^ "Markdown help". http://stackoverflow.com. Retrieved 29 March 2013. 
  13. ^ "SourceForge: Markdown Syntax Guide". sourceforge.net. Retrieved 2013-05-10. 
  14. ^ http://www.codinghorror.com/blog/2009/12/responsible-open-source-code-parenting.html
  15. ^ http://six.pairlist.net/pipermail/markdown-discuss/2012-October/002672.html
  16. ^ http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html
  17. ^ http://markdown.github.io/
  18. ^ http://johnmacfarlane.net/babelmark2/
  19. ^ http://johnmacfarlane.net/babelmark2/faq.html
  20. ^ http://www.stack.nl/~dimitri/doxygen/manual/markdown.html
  21. ^ https://github.com/rstudio/rstudio/blob/master/src/cpp/core/markdown/Markdown.cpp
  22. ^ http://plugins.jetbrains.com/plugin?id=5970
  23. ^ https://github.com/nicoulaj/idea-markdown
  24. ^ Joe Esposito. "Grip – Github Readme Instant Preview". GitHub-Flavored Markdown in the Python language.
  25. ^ Jeff Tratner. "Vim-Flavored-Markdown": Github Flavored Markdown in the Vim scripting language.
  26. ^ Evan Solomon. "GitHub-Flavored Markdown Comments": Github Flavored Markdown in the PHP language as a WordPress plugin.
  27. ^ Gabriel Llamas. "Node-GFM": GitHub flavored markdown in the JavaScript language.
  28. ^ Emanuil Rusev. "Parsedown": GitHub-Flavored Markdown in the PHP language.

External links[edit]