GitHub Markdown CSS demo
\n\n\n\nHeaders
\n\n# H1\n## H2\n### H3\n#### H4\n##### H5\n###### H6\n\nAlternatively, for H1 and H2, an underline-ish style:\n\nAlt-H1\n======\n\nAlt-H2\n------\nH1
\n\nH2
\n\nH3
\n\nH4
\n\nH5
\n\nH6
\n\nAlternatively, for H1 and H2, an underline-ish style:
\n\nAlt-H1
\n\nAlt-H2
\n\n\n\nEmphasis
\n\nEmphasis, aka italics, with *asterisks* or _underscores_.\n\nStrong emphasis, aka bold, with **asterisks** or __underscores__.\n\nCombined emphasis with **asterisks and _underscores_**.\n\nStrikethrough uses two tildes. ~~Scratch this.~~\nEmphasis, aka italics, with asterisks or underscores.
\n\nStrong emphasis, aka bold, with asterisks or underscores.
\n\nCombined emphasis with asterisks and underscores.
\n\nStrikethrough uses two tildes. Scratch this.
Lists
\n\n(In this example, leading and trailing spaces are shown with with dots: ⋅)
\n\n1. First ordered list item\n2. Another item\n⋅⋅* Unordered sub-list.\n1. Actual numbers don't matter, just that it's a number\n⋅⋅1. Ordered sub-list\n4. And another item.\n\n⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).\n\n⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅\n⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅\n⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)\n\n* Unordered list can use asterisks\n- Or minuses\n+ Or pluses\n- \n
- First ordered list item \n
- Another item\n\n
- \n
- Unordered sub-list. \n
\n - Actual numbers don't matter, just that it's a number\n\n
- \n
- Ordered sub-list \n
\n And another item.
\n\nYou can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
\n\nTo have a line break without a paragraph, you will need to use two trailing spaces.\n Note that this line is separate, but within the same paragraph.\n (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
\n
- \n
- Unordered list can use asterisks \n
- Or minuses \n
Or pluses
\n
- \n
- foo\n\n
- \n
- bar\n\n
- \n
- baz\n\n
- \n
- faz \n
\n
\n - baz\n\n
\n - bar\n\n
foo2
\n
- \n
- foo\n\n
- \n
- bar\n\n
- \n
- baz\n\n
- \n
- faz \n
\n
\n - baz\n\n
\n - bar\n\n
foo2
\n
- \n
foo
\n\n- \n
- bar\n\n
- \n
- baz\n\n
- \n
- faz \n
\n
\n - baz\n\n
\n- bar\n\n
- \n
foo
\n\n- \n
- bar\n\n
- \n
- baz\n\n
- \n
- faz \n
\n
\n - baz\n\n
\n- bar\n\n
- \n
- Lists in a list item:\n\n
- \n
- Indented four spaces.\n\n
- \n
- indented eight spaces. \n
\n - Four spaces again. \n
\n - Indented four spaces.\n\n
Multiple paragraphs in a list items:\nIt's best to indent the paragraphs four spaces\nYou can get away with three, but it can get\nconfusing when you nest other things.\nStick to four.
\n\nWe indented the first line an extra space to align\nit with these paragraphs. In real use, we might do\nthat to the entire list so that all items line up.
\n\nThis paragraph is still part of the list item, but it looks messy to humans. So it's a good idea to wrap your nested paragraphs manually, as we did with the first two.
\nBlockquotes in a list item:
\n\n\n
Skip a line and\nindent the >'s four spaces.
\n \nPreformatted text in a list item:
\n\nSkip a line and indent eight spaces.\nThat's four spaces for the list\nand four to trigger the code block.\n\n
Inline HTML
\n\nTo reboot your computer, press ctrl+alt+del.
\n\n\n\nLinks
\n\nThere are two ways to create links.
\n\n[I'm an inline-style link](https://www.google.com)\n\n[I'm an inline-style link with title](https://www.google.com \"Google's Homepage\")\n\n[I'm a reference-style link][Arbitrary case-insensitive reference text]\n\n[I'm a relative reference to a repository file](../blob/master/LICENSE)\n\n[You can use numbers for reference-style link definitions][1]\n\nOr leave it empty and use the [link text itself]\n\nSome text to show that the reference links can follow later.\n\n[arbitrary case-insensitive reference text]: https://www.mozilla.org\n[1]: http://slashdot.org\n[link text itself]: http://www.reddit.com\nI'm an inline-style link with title
\n\n\n\nI'm a relative reference to a repository file
\n\nYou can use numbers for reference-style link definitions
\n\nOr leave it empty and use the link text itself
\n\nSome text to show that the reference links can follow later.
\n\n\n\nImages
\n\nHere's our logo (hover to see the title text):\n\nInline-style:\n![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png \"Logo Title Text 1\")\n\nReference-style:\n![alt text][logo]\n\n[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png \"Logo Title Text 2\"\nHere's our logo (hover to see the title text):
\n\nInline-style:\n![\"alt](\"https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png\" "\\"Logo")
Reference-style:\n
Code and Syntax Highlighting
\n\nCode blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Which languages are supported and how those language names should be written will vary from renderer to renderer. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page.
\n\nInline `code` has `back-ticks around` it.\nInline code has back-ticks around it.
Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.
```javascript\nvar s = \"JavaScript syntax highlighting\";\nalert(s);\n```\n\n```python\ns = \"Python syntax highlighting\"\nprint s\n```\n\n```\nNo language indicated, so no syntax highlighting.\nBut let's throw in a <b>tag</b>.\n```\nvar s = \"JavaScript syntax highlighting\";\nalert(s);s = \"Python syntax highlighting\"\nprint sNo language indicated, so no syntax highlighting in Markdown Here (varies on Github).\nBut let's throw in a <b>tag</b>.\nTables
\n\nTables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application.
\n\nColons can be used to align columns.\n\n| Tables | Are | Cool |\n| ------------- |:-------------:| -----:|\n| col 3 is | right-aligned | |\n| col 2 is | centered | |\n| zebra stripes | are neat | |\n\nThe outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.\n\nMarkdown | Less | Pretty\n--- | --- | ---\n*Still* | `renders` | **nicely**\n1 | 2 | 3\nColons can be used to align columns.
\n\n| Tables | \nAre | \nCool | \n
|---|---|---|
| col 3 is | \nright-aligned | \n\n |
| col 2 is | \ncentered | \n\n |
| zebra stripes | \nare neat | \n\n |
The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
\n\n| Markdown | \nLess | \nPretty | \n
|---|---|---|
| Still | \nrenders | \nnicely | \n
| 1 | \n2 | \n3 | \n
Blockquotes
\n\n> Blockquotes are very handy in email to emulate reply text.\n> This line is part of the same quote.\n\nQuote break.\n\n> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.\n\n\n\nBlockquotes are very handy in email to emulate reply text.\nThis line is part of the same quote.
\n
Quote break.
\n\n\n\n\n\n\nThis is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
\n
Inline HTML
\n\nYou can also use raw HTML in your Markdown1, and it'll mostly work pretty well2.
\n\n<dl>\n <dt>Definition list</dt>\n <dd>Is something people use sometimes.</dd>\n\n <dt>Markdown in HTML</dt>\n <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>\n</dl>\n- \n
- Definition list \n
- Is something people use sometimes. \n\n
- Markdown in HTML \n
- Does *not* work **very** well. Use HTML tags. \n
Horizontal Rule
\n\nThree or more...\n\n---\n\nHyphens\n\n***\n\nAsterisks\n\n___\n\nUnderscores\nThree or more...
\n\n\n\n
Hyphens
\n\n\n\n
Asterisks
\n\n\n\n
Underscores
\n\n\n\nLine Breaks
\n\nMy basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. \"Markdown Toggle\" is your friend.
\n\nHere are some things to try out:
\n\nHere's a line for us to start with.\n\nThis line is separated from the one above by two newlines, so it will be a *separate paragraph*.\n\nThis line is also a separate paragraph, but...\nThis line is only separated by a single newline, so it's a separate line in the *same paragraph*.\nHere's a line for us to start with.
\n\nThis line is separated from the one above by two newlines, so it will be a separate paragraph.
\n\nThis line is also begins a separate paragraph, but...\nThis line is only separated by a single newline, so it's a separate line in the same paragraph.
\n\n(Technical note: Markdown Here uses GFM line breaks, so there's no need to use MD's two-space line breaks.)
\n\n\n\nYoutube videos
\n\nThey can't be added directly but you can add an image with a link to the video like this:
\n\n<a href=\"http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE\n\" target=\"_blank\"><img src=\"http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg\"\nalt=\"IMAGE ALT TEXT HERE\" width=\"240\" height=\"180\" border=\"10\" /></a>\nOr, in pure Markdown, but losing the image sizing and border:
\n\n[](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)\nReferencing a bug by #bugID in your git commit links it to the slip. For example #1.
\n\nTask List
\n\n- \n
- foo\n\n
- \n
- foo \n
- foo \n
\n - foo \n
[test]: http://google.com/ \"Google\"
\n\nA heading
\n\nJust a note, I've found that I can't test my markdown parser vs others.\nFor example, both markdown.js and showdown code blocks in lists wrong. They're\nalso completely [inconsistent][test] with regards to paragraphs in list items.
\n\nA link. Not anymore.
\n\nThis will make me fail the test because\nmarkdown.js doesnt acknowledge arbitrary html blocks =/\n\n- \n
List Item 1
\nList Item 2
\n\n- \n
- New List Item 1\nHi, this is a list item. \n
- New List Item 2\nAnother item\n Code goes here.\n Lots of it... \n
- New List Item 3\nThe last item \n
\nList Item 3\nThe final item.
\nList Item 4\nThe real final item.
\n
Paragraph.
\n\n\n\n\n\n
\n- bq Item 1
\n- bq Item 2\n\n
\n\n
- New bq Item 1
\n- New bq Item 2\nText here
\n
\n\n
\n\n\nAnother blockquote!\nI really need to get\nmore creative with\nmockup text..\nmarkdown.js breaks here again
\n
Another Heading
\n\nHello world. Here is a link.\nAnd an image .
Code goes here.\nLots of it...\n\n\n\nA list within a blockquote:
\n\n\n
\n- asterisk 1
\n- asterisk 2
\n- asterisk 3
\n
This is strong and em.
\n\nSo is this word.
\n\nThis is strong and em.
\n\nSo is this word.
\n\nUnordered
\n\nAsterisks tight:
\n\n- \n
- asterisk 1 \n
- asterisk 2 \n
- asterisk 3 \n
Asterisks loose:
\n\n- \n
asterisk 1
\nasterisk 2
\nasterisk 3
\n
\n\n
Pluses tight:
\n\n- \n
- Plus 1 \n
- Plus 2 \n
- Plus 3 \n
Pluses loose:
\n\n- \n
Plus 1
\nPlus 2
\nPlus 3
\n
\n\n
Minuses tight:
\n\n- \n
- Minus 1 \n
- Minus 2 \n
- Minus 3 \n
Minuses loose:
\n\n- \n
Minus 1
\nMinus 2
\nMinus 3
\n
Ordered
\n\nTight:
\n\n- \n
- First \n
- Second \n
- Third \n
and:
\n\n- \n
- One \n
- Two \n
- Three \n
Loose using tabs:
\n\n- \n
First
\nSecond
\nThird
\n
and using spaces:
\n\n- \n
One
\nTwo
\nThree
\n
Multiple paragraphs:
\n\n- \n
Item 1, graf one.
\n\nItem 2. graf two. The quick brown fox jumped over the lazy dog's\nback.
\nItem 2.
\nItem 3.
\n
Nested
\n\n- \n
- Tab\n\n
- \n
- Tab\n\n
- \n
- Tab \n
\n
\n - Tab\n\n
Here's another:
\n\n- \n
- First \n
- Second:\n\n
- \n
- Fee \n
- Fie \n
- Foe \n
\n - Third \n
Same thing but with paragraphs:
\n\n- \n
First
\nSecond:
\n\n- \n
- Fee \n
- Fie \n
- Foe \n
\nThird
\n
This was an error in Markdown 1.0.1:
\n\n- \n
this
\n\n- \n
- sub \n
that
\n
\n\n\nfoo
\n\n\n\n\nbar
\nfoo
\n
Markdown: Syntax
\n\n\n\n- \n
- Overview\n\n \n
- Block Elements\n\n
- \n
- Paragraphs and Line Breaks \n
- Headers \n
- Blockquotes \n
- Lists \n
- Code Blocks \n
- Horizontal Rules \n
\n - Span Elements\n\n \n
- Miscellaneous\n\n
- \n
- Backslash Escapes \n
- Automatic Links \n
\n
Note: This document is itself written using Markdown; you\ncan [see the source for it by adding '.text' to the URL][src].
\n\n[src]: /projects/markdown/syntax.text
\n\n\n\n
Overview
\n\nPhilosophy
\n\nMarkdown is intended to be as easy-to-read and easy-to-write as is feasible.
\n\nReadability, however, is emphasized above all else. A Markdown-formatted\ndocument should be publishable as-is, as plain text, without looking\nlike it's been marked up with tags or formatting instructions. While\nMarkdown's syntax has been influenced by several existing text-to-HTML\nfilters -- including Setext, [atx] [2], [Textile] [3], [reStructuredText] [4],\n[Grutatext] [5], and [EtText] [6] -- the single biggest source of\ninspiration for Markdown's syntax is the format of plain text email.
\n\n1: http://docutils.sourceforge.net/mirror/setext.html\n [2]: http://www.aaronsw.com/2002/atx/\n [3]: http://textism.com/tools/textile/\n [4]: http://docutils.sourceforge.net/rst.html\n [5]: http://www.triptico.com/software/grutatxt.html\n [6]: http://ettext.taint.org/doc/
\n\nTo this end, Markdown's syntax is comprised entirely of punctuation\ncharacters, which punctuation characters have been carefully chosen so\nas to look like what they mean. E.g., asterisks around a word actually\nlook like *emphasis*. Markdown lists look like, well, lists. Even\nblockquotes look like quoted passages of text, assuming you've ever\nused email.
\n\nInline HTML
\n\nMarkdown's syntax is intended for one purpose: to be used as a\nformat for writing for the web.
\n\nMarkdown is not a replacement for HTML, or even close to it. Its\nsyntax is very small, corresponding only to a very small subset of\nHTML tags. The idea is not to create a syntax that makes it easier\nto insert HTML tags. In my opinion, HTML tags are already easy to\ninsert. The idea for Markdown is to make it easy to read, write, and\nedit prose. HTML is a publishing format; Markdown is a writing\nformat. Thus, Markdown's formatting syntax only addresses issues that\ncan be conveyed in plain text.
\n\nFor any markup that is not covered by Markdown's syntax, you simply\nuse HTML itself. There's no need to preface it or delimit it to\nindicate that you're switching from Markdown to HTML; you just use\nthe tags.
\n\nThe only restrictions are that block-level HTML elements -- e.g. <div>,\n<table>, <pre>, <p>, etc. -- must be separated from surrounding\ncontent by blank lines, and the start and end tags of the block should\nnot be indented with tabs or spaces. Markdown is smart enough not\nto add extra (unwanted) <p> tags around HTML block-level tags.
For example, to add an HTML table to a Markdown article:
\n\nThis is a regular paragraph.\n\n<table>\n <tr>\n <td>Foo</td>\n </tr>\n</table>\n\nThis is another regular paragraph.\nNote that Markdown formatting syntax is not processed within block-level\nHTML tags. E.g., you can't use Markdown-style *emphasis* inside an\nHTML block.
Span-level HTML tags -- e.g. <span>, <cite>, or <del> -- can be\nused anywhere in a Markdown paragraph, list item, or header. If you\nwant, you can even use HTML tags instead of Markdown formatting; e.g. if\nyou'd prefer to use HTML <a> or <img> tags instead of Markdown's\nlink or image syntax, go right ahead.
Unlike block-level HTML tags, Markdown syntax is processed within\nspan-level tags.
\n\nAutomatic Escaping for Special Characters
\n\nIn HTML, there are two characters that demand special treatment: <\nand &. Left angle brackets are used to start tags; ampersands are\nused to denote HTML entities. If you want to use them as literal\ncharacters, you must escape them as entities, e.g. <, and\n&.
Ampersands in particular are bedeviling for web writers. If you want to\nwrite about 'AT&T', you need to write 'AT&T'. You even need to\nescape ampersands within URLs. Thus, if you want to link to:
http://images.google.com/images?num=30&q=larry+bird\nyou need to encode the URL as:
\n\nhttp://images.google.com/images?num=30&q=larry+bird\nin your anchor tag href attribute. Needless to say, this is easy to\nforget, and is probably the single most common source of HTML validation\nerrors in otherwise well-marked-up web sites.
Markdown allows you to use these characters naturally, taking care of\nall the necessary escaping for you. If you use an ampersand as part of\nan HTML entity, it remains unchanged; otherwise it will be translated\ninto &.
So, if you want to include a copyright symbol in your article, you can write:
\n\n©\nand Markdown will leave it alone. But if you write:
\n\nAT&T\nMarkdown will translate it to:
\n\nAT&T\nSimilarly, because Markdown supports inline HTML, if you use\nangle brackets as delimiters for HTML tags, Markdown will treat them as\nsuch. But if you write:
\n\n4 < 5\nMarkdown will translate it to:
\n\n4 < 5\nHowever, inside Markdown code spans and blocks, angle brackets and\nampersands are always encoded automatically. This makes it easy to use\nMarkdown to write about HTML code. (As opposed to raw HTML, which is a\nterrible format for writing about HTML syntax, because every single <\nand & in your example code needs to be escaped.)
\n\n
Block Elements
\n\nParagraphs and Line Breaks
\n\nA paragraph is simply one or more consecutive lines of text, separated\nby one or more blank lines. (A blank line is any line that looks like a\nblank line -- a line containing nothing but spaces or tabs is considered\nblank.) Normal paragraphs should not be intended with spaces or tabs.
\n\nThe implication of the \"one or more consecutive lines of text\" rule is\nthat Markdown supports \"hard-wrapped\" text paragraphs. This differs\nsignificantly from most other text-to-HTML formatters (including Movable\nType's \"Convert Line Breaks\" option) which translate every line break\ncharacter in a paragraph into a <br /> tag.
When you do want to insert a <br /> break tag using Markdown, you\nend a line with two or more spaces, then type return.
Yes, this takes a tad more effort to create a <br />, but a simplistic\n\"every line break is a <br />\" rule wouldn't work for Markdown.\nMarkdown's email-style [blockquoting][bq] and multi-paragraph [list items][l]\nwork best -- and look better -- when you format them with hard breaks.
[bq]: #blockquote\n [l]: #list
\n\nHeaders
\n\nMarkdown supports two styles of headers, Setext and [atx] [2].
\n\nSetext-style headers are \"underlined\" using equal signs (for first-level\nheaders) and dashes (for second-level headers). For example:
\n\nThis is an H1\n=============\n\nThis is an H2\n-------------\nAny number of underlining ='s or -'s will work.
Atx-style headers use 1-6 hash characters at the start of the line,\ncorresponding to header levels 1-6. For example:
\n\n# This is an H1\n\n## This is an H2\n\n###### This is an H6\nOptionally, you may \"close\" atx-style headers. This is purely\ncosmetic -- you can use this if you think it looks better. The\nclosing hashes don't even need to match the number of hashes\nused to open the header. (The number of opening hashes\ndetermines the header level.) :
\n\n# This is an H1 #\n\n## This is an H2 ##\n\n### This is an H3 ######\nBlockquotes
\n\nMarkdown uses email-style > characters for blockquoting. If you're\nfamiliar with quoting passages of text in an email message, then you\nknow how to create a blockquote in Markdown. It looks best if you hard\nwrap the text and put a > before every line:
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\n> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\n> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n>\n> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\n> id sem consectetuer libero luctus adipiscing.\nMarkdown allows you to be lazy and only put the > before the first\nline of a hard-wrapped paragraph:
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\nconsectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\nVestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n\n> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\nid sem consectetuer libero luctus adipiscing.\nBlockquotes can be nested (i.e. a blockquote-in-a-blockquote) by\nadding additional levels of >:
> This is the first level of quoting.\n>\n> > This is nested blockquote.\n>\n> Back to the first level.\nBlockquotes can contain other Markdown elements, including headers, lists,\nand code blocks:
\n\n> ## This is a header.\n>\n> 1. This is the first list item.\n> 2. This is the second list item.\n>\n> Here's some example code:\n>\n> return shell_exec(\"echo $input | $markdown_script\");\nAny decent text editor should make email-style quoting easy. For\nexample, with BBEdit, you can make a selection and choose Increase\nQuote Level from the Text menu.
\n\nLists
\n\nMarkdown supports ordered (numbered) and unordered (bulleted) lists.
\n\nUnordered lists use asterisks, pluses, and hyphens -- interchangably\n-- as list markers:
\n\n* Red\n* Green\n* Blue\nis equivalent to:
\n\n+ Red\n+ Green\n+ Blue\nand:
\n\n- Red\n- Green\n- Blue\nOrdered lists use numbers followed by periods:
\n\n1. Bird\n2. McHale\n3. Parish\nIt's important to note that the actual numbers you use to mark the\nlist have no effect on the HTML output Markdown produces. The HTML\nMarkdown produces from the above list is:
\n\n<ol>\n<li>Bird</li>\n<li>McHale</li>\n<li>Parish</li>\n</ol>\nIf you instead wrote the list in Markdown like this:
\n\n1. Bird\n1. McHale\n1. Parish\nor even:
\n\n3. Bird\n1. McHale\n8. Parish\nyou'd get the exact same HTML output. The point is, if you want to,\nyou can use ordinal numbers in your ordered Markdown lists, so that\nthe numbers in your source match the numbers in your published HTML.\nBut if you want to be lazy, you don't have to.
\n\nIf you do use lazy list numbering, however, you should still start the\nlist with the number 1. At some point in the future, Markdown may support\nstarting ordered lists at an arbitrary number.
\n\nList markers typically start at the left margin, but may be indented by\nup to three spaces. List markers must be followed by one or more spaces\nor a tab.
\n\nTo make lists look nice, you can wrap items with hanging indents:
\n\n* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\n Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\n viverra nec, fringilla in, laoreet vitae, risus.\n* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\n Suspendisse id sem consectetuer libero luctus adipiscing.\nBut if you want to be lazy, you don't have to:
\n\n* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\nAliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\nviverra nec, fringilla in, laoreet vitae, risus.\n* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\nSuspendisse id sem consectetuer libero luctus adipiscing.\nIf list items are separated by blank lines, Markdown will wrap the\nitems in <p> tags in the HTML output. For example, this input:
* Bird\n* Magic\nwill turn into:
\n\n<ul>\n<li>Bird</li>\n<li>Magic</li>\n</ul>\nBut this:
\n\n* Bird\n\n* Magic\nwill turn into:
\n\n<ul>\n<li><p>Bird</p></li>\n<li><p>Magic</p></li>\n</ul>\nList items may consist of multiple paragraphs. Each subsequent\nparagraph in a list item must be intended by either 4 spaces\nor one tab:
\n\n1. This is a list item with two paragraphs. Lorem ipsum dolor\n sit amet, consectetuer adipiscing elit. Aliquam hendrerit\n mi posuere lectus.\n\n Vestibulum enim wisi, viverra nec, fringilla in, laoreet\n vitae, risus. Donec sit amet nisl. Aliquam semper ipsum\n sit amet velit.\n\n2. Suspendisse id sem consectetuer libero luctus adipiscing.\nIt looks nice if you indent every line of the subsequent\nparagraphs, but here again, Markdown will allow you to be\nlazy:
\n\n* This is a list item with two paragraphs.\n\n This is the second paragraph in the list item. You're\nonly required to indent the first line. Lorem ipsum dolor\nsit amet, consectetuer adipiscing elit.\n\n* Another item in the same list.\nTo put a blockquote within a list item, the blockquote's >\ndelimiters need to be indented:
* A list item with a blockquote:\n\n > This is a blockquote\n > inside a list item.\nTo put a code block within a list item, the code block needs\nto be indented twice -- 8 spaces or two tabs:
\n\n* A list item with a code block:\n\n <code goes here>\nIt's worth noting that it's possible to trigger an ordered list by\naccident, by writing something like this:
\n\n1986. What a great season.\nIn other words, a number-period-space sequence at the beginning of a\nline. To avoid this, you can backslash-escape the period:
\n\n1986\\. What a great season.\nCode Blocks
\n\nPre-formatted code blocks are used for writing about programming or\nmarkup source code. Rather than forming normal paragraphs, the lines\nof a code block are interpreted literally. Markdown wraps a code block\nin both <pre> and <code> tags.
To produce a code block in Markdown, simply indent every line of the\nblock by at least 4 spaces or 1 tab. For example, given this input:
\n\nThis is a normal paragraph:\n\n This is a code block.\nMarkdown will generate:
\n\n<p>This is a normal paragraph:</p>\n\n<pre><code>This is a code block.\n</code></pre>\nOne level of indentation -- 4 spaces or 1 tab -- is removed from each\nline of the code block. For example, this:
\n\nHere is an example of AppleScript:\n\n tell application \"Foo\"\n beep\n end tell\nwill turn into:
\n\n<p>Here is an example of AppleScript:</p>\n\n<pre><code>tell application \"Foo\"\n beep\nend tell\n</code></pre>\nA code block continues until it reaches a line that is not indented\n(or the end of the article).
\n\nWithin a code block, ampersands (&) and angle brackets (< and >)\nare automatically converted into HTML entities. This makes it very\neasy to include example HTML source code using Markdown -- just paste\nit and indent it, and Markdown will handle the hassle of encoding the\nampersands and angle brackets. For example, this:
<div class=\"footer\">\n © 2004 Foo Corporation\n </div>\nwill turn into:
\n\n<pre><code><div class=\"footer\">\n &copy; 2004 Foo Corporation\n</div>\n</code></pre>\nRegular Markdown syntax is not processed within code blocks. E.g.,\nasterisks are just literal asterisks within a code block. This means\nit's also easy to use Markdown to write about Markdown's own syntax.
\n\nHorizontal Rules
\n\nYou can produce a horizontal rule tag (<hr />) by placing three or\nmore hyphens, asterisks, or underscores on a line by themselves. If you\nwish, you may use spaces between the hyphens or asterisks. Each of the\nfollowing lines will produce a horizontal rule:
* * *\n\n***\n\n*****\n\n- - -\n\n---------------------------------------\n\n_ _ _\n\n\n
Span Elements
\n\nLinks
\n\nMarkdown supports two style of links: inline and reference.
\n\nIn both styles, the link text is delimited by [square brackets].
\n\nTo create an inline link, use a set of regular parentheses immediately\nafter the link text's closing square bracket. Inside the parentheses,\nput the URL where you want the link to point, along with an optional\ntitle for the link, surrounded in quotes. For example:
\n\nThis is [an example](http://example.com/ \"Title\") inline link.\n\n[This link](http://example.net/) has no title attribute.\nWill produce:
\n\n<p>This is <a href=\"http://example.com/\" title=\"Title\">\nan example</a> inline link.</p>\n\n<p><a href=\"http://example.net/\">This link</a> has no\ntitle attribute.</p>\nIf you're referring to a local resource on the same server, you can\nuse relative paths:
\n\nSee my [About](/about/) page for details.\nReference-style links use a second set of square brackets, inside\nwhich you place a label of your choosing to identify the link:
\n\nThis is [an example][id] reference-style link.\nYou can optionally use a space to separate the sets of brackets:
\n\nThis is [an example] [id] reference-style link.\nThen, anywhere in the document, you define your link label like this,\non a line by itself:
\n\n[id]: http://example.com/ \"Optional Title Here\"\nThat is:
\n\n- \n
- Square brackets containing the link identifier (optionally\nindented from the left margin using up to three spaces); \n
- followed by a colon; \n
- followed by one or more spaces (or tabs); \n
- followed by the URL for the link; \n
- optionally followed by a title attribute for the link, enclosed\nin double or single quotes. \n
The link URL may, optionally, be surrounded by angle brackets:
\n\n[id]: <http://example.com/> \"Optional Title Here\"\nYou can put the title attribute on the next line and use extra spaces\nor tabs for padding, which tends to look better with longer URLs:
\n\n[id]: http://example.com/longish/path/to/resource/here\n \"Optional Title Here\"\nLink definitions are only used for creating links during Markdown\nprocessing, and are stripped from your document in the HTML output.
\n\nLink definition names may constist of letters, numbers, spaces, and punctuation -- but they are not case sensitive. E.g. these two links:
\n\n[link text][a]\n[link text][A]\nare equivalent.
\n\nThe implicit link name shortcut allows you to omit the name of the\nlink, in which case the link text itself is used as the name.\nJust use an empty set of square brackets -- e.g., to link the word\n\"Google\" to the google.com web site, you could simply write:
\n\n[Google][]\nAnd then define the link:
\n\n[Google]: http://google.com/\nBecause link names may contain spaces, this shortcut even works for\nmultiple words in the link text:
\n\nVisit [Daring Fireball][] for more information.\nAnd then define the link:
\n\n[Daring Fireball]: http://daringfireball.net/\nLink definitions can be placed anywhere in your Markdown document. I\ntend to put them immediately after each paragraph in which they're\nused, but if you want, you can put them all at the end of your\ndocument, sort of like footnotes.
\n\nHere's an example of reference links in action:
\n\nI get 10 times more traffic from [Google] [1] than from\n[Yahoo] [2] or [MSN] [3].\n\n [1]: http://google.com/ \"Google\"\n [2]: http://search.yahoo.com/ \"Yahoo Search\"\n [3]: http://search.msn.com/ \"MSN Search\"\nUsing the implicit link name shortcut, you could instead write:
\n\nI get 10 times more traffic from [Google][] than from\n[Yahoo][] or [MSN][].\n\n [google]: http://google.com/ \"Google\"\n [yahoo]: http://search.yahoo.com/ \"Yahoo Search\"\n [msn]: http://search.msn.com/ \"MSN Search\"\nBoth of the above examples will produce the following HTML output:
\n\n<p>I get 10 times more traffic from <a href=\"http://google.com/\"\ntitle=\"Google\">Google</a> than from\n<a href=\"http://search.yahoo.com/\" title=\"Yahoo Search\">Yahoo</a>\nor <a href=\"http://search.msn.com/\" title=\"MSN Search\">MSN</a>.</p>\nFor comparison, here is the same paragraph written using\nMarkdown's inline link style:
\n\nI get 10 times more traffic from [Google](http://google.com/ \"Google\")\nthan from [Yahoo](http://search.yahoo.com/ \"Yahoo Search\") or\n[MSN](http://search.msn.com/ \"MSN Search\").\nThe point of reference-style links is not that they're easier to\nwrite. The point is that with reference-style links, your document\nsource is vastly more readable. Compare the above examples: using\nreference-style links, the paragraph itself is only 81 characters\nlong; with inline-style links, it's 176 characters; and as raw HTML,\nit's 234 characters. In the raw HTML, there's more markup than there\nis text.
\n\nWith Markdown's reference-style links, a source document much more\nclosely resembles the final output, as rendered in a browser. By\nallowing you to move the markup-related metadata out of the paragraph,\nyou can add links without interrupting the narrative flow of your\nprose.
\n\nEmphasis
\n\nMarkdown treats asterisks (*) and underscores (_) as indicators of\nemphasis. Text wrapped with one * or _ will be wrapped with an\nHTML <em> tag; double *'s or _'s will be wrapped with an HTML\n<strong> tag. E.g., this input:
*single asterisks*\n\n_single underscores_\n\n**double asterisks**\n\n__double underscores__\nwill produce:
\n\n<em>single asterisks</em>\n\n<em>single underscores</em>\n\n<strong>double asterisks</strong>\n\n<strong>double underscores</strong>\nYou can use whichever style you prefer; the lone restriction is that\nthe same character must be used to open and close an emphasis span.
\n\nEmphasis can be used in the middle of a word:
\n\nun*fucking*believable\nBut if you surround an * or _ with spaces, it'll be treated as a\nliteral asterisk or underscore.
To produce a literal asterisk or underscore at a position where it\nwould otherwise be used as an emphasis delimiter, you can backslash\nescape it:
\n\n\\*this text is surrounded by literal asterisks\\*\nCode
\n\nTo indicate a span of code, wrap it with backtick quotes (`).\nUnlike a pre-formatted code block, a code span indicates code within a\nnormal paragraph. For example:
Use the `printf()` function.\nwill produce:
\n\n<p>Use the <code>printf()</code> function.</p>\nTo include a literal backtick character within a code span, you can use\nmultiple backticks as the opening and closing delimiters:
\n\n``There is a literal backtick (`) here.``\nwhich will produce this:
\n\n<p><code>There is a literal backtick (`) here.</code></p>\nThe backtick delimiters surrounding a code span may include spaces --\none after the opening, one before the closing. This allows you to place\nliteral backtick characters at the beginning or end of a code span:
\n\nA single backtick in a code span: `` ` ``\n\nA backtick-delimited string in a code span: `` `foo` ``\nwill produce:
\n\n<p>A single backtick in a code span: <code>`</code></p>\n\n<p>A backtick-delimited string in a code span: <code>`foo`</code></p>\nWith a code span, ampersands and angle brackets are encoded as HTML\nentities automatically, which makes it easy to include example HTML\ntags. Markdown will turn this:
\n\nPlease don't use any `<blink>` tags.\ninto:
\n\n<p>Please don't use any <code><blink></code> tags.</p>\nYou can write this:
\n\n`—` is the decimal-encoded equivalent of `—`.\nto produce:
\n\n<p><code>&#8212;</code> is the decimal-encoded\nequivalent of <code>&mdash;</code>.</p>\nImages
\n\nAdmittedly, it's fairly difficult to devise a \"natural\" syntax for\nplacing images into a plain text document format.
\n\nMarkdown uses an image syntax that is intended to resemble the syntax\nfor links, allowing for two styles: inline and reference.
\n\nInline image syntax looks like this:
\n\n\n\n![Alt text](/path/to/img.jpg \"Optional title\")\nThat is:
\n\n- \n
- An exclamation mark:
!; \n - followed by a set of square brackets, containing the
alt\nattribute text for the image; \n - followed by a set of parentheses, containing the URL or path to\nthe image, and an optional
titleattribute enclosed in double\nor single quotes. \n
Reference-style image syntax looks like this:
\n\n![Alt text][id]\nWhere \"id\" is the name of a defined image reference. Image references\nare defined using syntax identical to link references:
\n\n[id]: url/to/image \"Optional title attribute\"\nAs of this writing, Markdown has no syntax for specifying the\ndimensions of an image; if this is important to you, you can simply\nuse regular HTML <img> tags.
\n\n
Miscellaneous
\n\nAutomatic Links
\n\nMarkdown supports a shortcut style for creating \"automatic\" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:
\n\n<http://example.com/>\nMarkdown will turn this into:
\n\n<a href=\"http://example.com/\">http://example.com/</a>\nAutomatic links for email addresses work similarly, except that\nMarkdown will also perform a bit of randomized decimal and hex\nentity-encoding to help obscure your address from address-harvesting\nspambots. For example, Markdown will turn this:
\n\n<address@example.com>\ninto something like this:
\n\n<a href=\"mailto:addre\nss@example.co\nm\">address@exa\nmple.com</a>\nwhich will render in a browser as a clickable link to \"address@example.com\".
\n\n(This sort of entity-encoding trick will indeed fool many, if not\nmost, address-harvesting bots, but it definitely won't fool all of\nthem. It's better than nothing, but an address published in this way\nwill probably eventually start receiving spam.)
\n\nBackslash Escapes
\n\nMarkdown allows you to use backslash escapes to generate literal\ncharacters which would otherwise have special meaning in Markdown's\nformatting syntax. For example, if you wanted to surround a word with\nliteral asterisks (instead of an HTML <em> tag), you can backslashes\nbefore the asterisks, like this:
\\*literal asterisks\\*\nMarkdown provides backslash escapes for the following characters:
\n\n\\ backslash\n` backtick\n* asterisk\n_ underscore\n{} curly braces\n[] square brackets\n() parentheses\n# hash mark\n+ plus sign\n- minus sign (hyphen)\n. dot\n! exclamation mark\nFoo [bar][].
\n\nFoo bar.
\n\n[bar]: /url/ \"Title with \"quotes\" inside\"
\n\nThis is the [simple case].
\n\n[simple case]: /simple
\n\nThis one has a [line\nbreak].
\n\nThis one has a [line\nbreak] with a line-ending space.
\n\n[line break]: /foo
\n\n[this] [that] and the [other]
\n\n[this]: /this\n[that]: /that\n[other]: /other
\n\nHere's a simple block:
\n\nThis should be a code block, though:
\n\n<div>\n foo\n</div>\nAs should this:
\n\n<div>foo</div>\nNow, nested:
\n\nThis should just be an HTML comment:
\n\n\n\nMultiline:
\n\n\n\nCode block:
\n\n<!-- Comment -->\nJust plain comment, with trailing spaces on the line:
\n\n\n\nCode:
\n\n<hr />\nHr's:
\n\n\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
var gulp = require('gulp');\nvar myth = require('gulp-myth');\n\ngulp.task('default', function () {\n return gulp.src('src/app.css')\n .pipe(myth())\n .pipe(gulp.dest('dist'));\n});Footnotes
\n\nHere's an example of footnotes in action. This paragraph contains multiple footnote references3 to demonstrate how they appear in GitHub-style Markdown4.
\n\nFootnotes
\n- \n
- \n
HTML elements like
\n<em>and<strong>are supported natively. ↩ \n - \n
Though there are some limitations compared to pure Markdown syntax. ↩
\n \n - \n
Footnotes are automatically numbered and linked back to their references. ↩
\n \n - \n
GitHub's Markdown processor generates this exact HTML structure for footnotes. ↩
\n \n
![](\"https://cloud.githubusercontent.com/assets/170270/5219062/f22a978c-7685-11e4-8316-af25b6c89bc0.png\")
](http://sindresorhus.com/github-markdown-css)\n\n## [Demo](https://sindresorhus.com/github-markdown-css)\n\n## Install\n\nDownload [manually](https://raw.githubusercontent.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css), from [CDNJS](https://cdnjs.com/libraries/github-markdown-css), or with npm:\n\n```sh\nnpm install github-markdown-css\n```\n\n## Usage\n\nImport the `github-markdown.css` file and add a `markdown-body` class to the container of your rendered Markdown and set a width for it. GitHub uses `980px` width and `45px` padding, and `15px` padding for mobile.\n\n```html\n\n\n\n