NOTE: This “post” is based on Markdown Cheatsheet and is meant to test styling of Markdown generated documents.
\nThis is intended as a quick reference and showcase. For more complete info, see John Gruber’s original spec and the Github-flavored Markdown info page.
\nThis cheatsheet is specifically Markdown Here’s version of Github-flavored Markdown. This differs slightly in styling and syntax from what Github uses, so what you see below might vary a little from what you get in a Markdown Here email, but it should be pretty close.
\nYou can play around with Markdown on our live demo page.
\n(If you’re not a Markdown Here user, check out the Markdown Cheatsheet that is not specific to MDH. But, really, you should also use Markdown Here, because it’s awesome. http://markdown-here.com)
\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------Alternatively, for H1 and H2, an underline-ish style:
\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.~~Emphasis, aka italics, with asterisks or underscores.
\nStrong emphasis, aka bold, with asterisks or underscores.
\nCombined emphasis with asterisks and underscores.
\nStrikethrough uses two tildes. Scratch this.
1. 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 Some text that should be aligned with the above item.\n\n* Unordered list can use asterisks\n- Or minuses\n+ Or plusesFirst ordered list item
\nAnother item
\nActual numbers don’t matter, just that it’s a number
\nAnd another item.
\nSome text that should be aligned with the above item.
\nUnordered list can use asterisks
\nOr minuses
\nOr pluses
\nThere are two ways to create links.
\n[I'm an inline-style link](https://www.google.com)\n\n[I'm a reference-style link][Arbitrary case-insensitive reference text]\n\n[You can use numbers for reference-style link definitions][1]\n\nOr leave it empty and use the [link text itself]\n\nURLs and URLs in angle brackets will automatically get turned into links.\nhttp://www.example.com or <http://www.example.com> and sometimes\nexample.com (but not on Github, for example).\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.comYou can use numbers for reference-style link definitions
\nOr leave it empty and use the link text itself
\nURLs and URLs in angle brackets will automatically get turned into links.\nhttp://www.example.com or http://www.example.com and sometimes\nexample.com (but not on Github, for example).
\nSome text to show that the reference links can follow later.
\n\nHere's our logo (hover to see the title text):\n\nInline-style:\n\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"Here’s our logo (hover to see the title text):
\nInline-style:\n![\"alt](\"https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png\" "\\"Logo")
Reference-style:\n
Code blocks are part of the Markdown spec, but syntax highlighting isn’t. However, many renderers — like Github’s and Markdown Here — support syntax highlighting. 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.
\nInline `code` has `back-ticks around` it.Inline 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>.Again, to see what languages are available for highlighting, and how to write those language names, see the highlight.js demo page.
\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.
\nColons can be used to align columns.\n\n| Tables | Are | Cool |\n| ------------- |:-------------:| -----:|\n| col 3 is | right-aligned | $1600 |\n| col 2 is | centered | $12 |\n| zebra stripes | are neat | $1 |\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 | 3Colons can be used to align columns.
\n| Tables | \nAre | \nCool | \n
|---|---|---|
| col 3 is | \nright-aligned | \n$1600 | \n
| col 2 is | \ncentered | \n$12 | \n
| zebra stripes | \nare neat | \n$1 | \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| Markdown | \nLess | \nPretty | \n
|---|---|---|
| Still | \nrenders | \nnicely | \n
| 1 | \n2 | \n3 | \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\nBlockquotes are very handy in email to emulate reply text.\nThis line is part of the same quote.
\n
Quote break.
\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
You can also use raw HTML in your Markdown, and it’ll mostly work pretty well.
\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>Three or more...\n\n---\n\nHyphens\n\n***\n\nAsterisks\n\n___\n\nUnderscoresThree or more…
\nHyphens
\nAsterisks
\nUnderscores
\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.
\nHere are some things to try out:
\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*.Here’s a line for us to start with.
\nThis line is separated from the one above by two newlines, so it will be a separate paragraph.
\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(Technical note: Markdown Here uses GFM line breaks, so there’s no need to use MD’s two-space line breaks.)
\n\nThey can’t be added directly but you can add an image with a link to the video like this:
\n<a href="http://www.youtube.com/watch?feature=player_embedded&v=8AkLfYOgIrE\n" target="_blank"><img src="http://img.youtube.com/vi/8AkLfYOgIrE/0.jpg"\nalt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a>Or, in pure Markdown, but losing the image sizing and border:
\n[](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)