Skip to content

Instantly share code, notes, and snippets.

@randria
Last active August 29, 2015 13:56
Show Gist options
  • Save randria/9267476 to your computer and use it in GitHub Desktop.
Save randria/9267476 to your computer and use it in GitHub Desktop.
markdown sandbox

Sometimes you want numbered lists:

  1. One *One*
  2. Two **Two**
  3. Three ~~Three~~

Sometimes you want bullet points:

  • Start a line with a star
  • Profit!
First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

Alternatively,

  • Dashes work just as well
  • And if you have sub points, put two spaces before the dash or star:
    • Like this
    • And this

It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!.

Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

This is a third-tier heading

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

Coffee. The finest organic suspension ever devised... I beat the Borg with it.

  • Captain Janeway

Code

There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true. If you've got a longer block of code, you can indent with four spaces:

if (isAwesome){
  return true
}

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

if (isAwesome){
  return true
}

And if you'd like to use syntax highlighting, include the language:

if (isAwesome){
  return true
}

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!

But I have to admit, tasks lists are my favorite:

  • This is a complete item
  • This is an incomplete item

And, of course emoji! ✨ 🐫 💥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment