Skip to content

Instantly share code, notes, and snippets.

@evaneykelen
Last active April 7, 2019 11:44
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save evaneykelen/fd8d3b448ea4c2edec93c34baca44ad4 to your computer and use it in GitHub Desktop.
Save evaneykelen/fd8d3b448ea4c2edec93c34baca44ad4 to your computer and use it in GitHub Desktop.

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

Sometimes you want numbered lists:

  1. One
  2. Two
  3. Three

Sometimes you want bullet points:

  • Start a line with a star
  • Profit!

Alternatively,

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

If you want to embed images, this is how you do it:

Image of Yaktocat

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

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
}

Source: https://guides.github.com/features/mastering-markdown/

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