Markdown Quick Reference
Markdown is a very simple text formatting language that is expressed in plain text and which can be converted by a markdown processor into HTML. The name is a play on the fact that HTML is markup language. It is often used in web applications where we want to give a user of a web site a way of creating formatted text without having to go to the complexity of authoring HTML, for example in a discussion forum. It was created in 2004 by John Gruber and Aaron Swartz
The only slight problem I find is that I forget a few of the markdown syntax rules. It really is simple enough to remember, except that for a moment you might forget which way the square and round brackets go for a link, or how to get italics. Markdown flavours vary, but most of the basic features should work in all of them, so here's a quick reference.
# Heading ## Subheading ### Subsubheading #### etc. Blank line -> new paragraph Two spaces at end of line -> line break (BR tag) *italic* _italic_ (EM tag) **bold** __bold__ (STRONG tag) ~~strikethrough~~ (DEL tag) `unformatted text` (back-tick for inline CODE tag) unformatted text (indent four spaces or a tab) more unformatted text (block within PRE and CODE tags) --- (horizontal rule - HR tag) * bullet * list 1. numbered 2. list > block quote (BLOCKQUOTE tag) > > block quote second paragraph [link text](http://link.address.com/) [link text](http://link.address.com/ "title attribute") ![image alt text](/images/myimage) ![image alt text](/images/myimage "image description for title attribute") [![link text](http://link.address.com/)](/images/myimage) [![link text](http://link.address.com/)](/images/myimage "image description for title attribute") <http://link.address.com/> (shortcut link syntax where link text is the link itself Simple | HTML | Table (use colon instead of space to set alignment) ----- |:---:| --- 1 | 2 | 3 4 | 5 | 6
If you want literal characters without being converted use the backslash escape, e.g.
\*not italic, just asterisks\*.
And don't forget to escape the < character (<) to avoid it being interpreted as HTML.
It helps to know what HTML tags are being rendered when it comes to working with CSS to style the resulting HTML markup.