Markdown Cheat Sheet
Examples of how to do it.

This is a post for me to reference with markdown on it, so I know what the syntax is. It is based on this markdown cheatsheet tweaked for Kramdown.

Headers

H1

H2

H3

H4

Text effects

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

use HTML element for strikethrough

Subscript text must be done using using HTML

Superscript text also with HTML

Lits

  1. First ordered list item
  2. Another item
    • Unordered sub-list.
  3. Actual numbers don’t matter, just that it’s a number
  4. Ordered sub-list
  5. And another item.

    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).

    To have a line break without a paragraph, you will need to use two trailing spaces.
    Note that this line is separate, but within the same paragraph.

I’m an inline-style link

I’m an inline-style link with title

Use angle brackets to get a link http://www.example.com

Images

Inline-style: alt text

Reference-style: alt text

   
image in table alt text

HTML:

Tables

Colons can be used to align columns.

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don’t need to make the raw Markdown line up prettily. You can also use inline Markdown.

Markdown Less Pretty
Still renders nicely
1 2 3

Code

Some code here…

// little snippet
angular.module('myApp')
  .controller('MainCtrl', function() {
      this.awesomeThings = [
        'angularjs',
        'javascript',
        'lodash'
      ];
  });

Gists

Embed a gist like this…

Blockquotes

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

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.

Inline HTML

You can also use raw HTML in your Markdown, and it’ll mostly work pretty well.

Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.

Horizontal Rule

Three or more hypens (or asterisk or underscore)


Equations

Using MathJax.

Inline:

Block:

*****
James Burton on 01 December 2015