Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

Markdown Cheat sheet

Quick cut and paste examples.

Emphasis

  • Bold **
  • Italic *
  • Bold and italic
  • Strikethrough ~~

Lists

Lists come in two flavors: Bulleted and numbered

Bulleted (Unordered) *

Unordered list can use asterisks (*), plus's (+), or minus's (-). They can be nested like so.

  • Item 1
    • Item 2
      • Item 3
    • Item 4
  • Item 5

Numbered (Ordered) 1.

Numered sub-lists appear to be unsupported in stock VSCode 0.o

  1. First ordered list item
  2. Second item
  3. Actual numbers don't matter, just that it's a number

Links

Links can be either inline or reference.

Images

An image in markdown contains:

  • An alternate description (think screen-readers, lynx)
  • URI to file
  • An optional caption (think XKCD commentary)

Images (Inline)

XKCD A-Minus-Minus

Images (Reference)

XKCD A new CAPTCHA approach

code

Inline code is useful for highlighting simple commands.

johnycsh$ docker ps

Code blocks are indicated with three backticks. Many markdown engines support hinting at the syntax.

var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s

Blockquotes (>)

Blockquotes can be used to render previous parts of a conversation in the same way that a mail reader would have in the early 90's.

They are handy for delineating replies and responses.

Tables

Tables are a markdown extensions defined by in Github Flavored Markdown. Commonly referred to as GFM

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment