Skip to content

Instantly share code, notes, and snippets.

@evanpeck
Last active October 10, 2018 14:37
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 evanpeck/65ff0d2887f6a56585cba871c3df673d to your computer and use it in GitHub Desktop.
Save evanpeck/65ff0d2887f6a56585cba871c3df673d to your computer and use it in GitHub Desktop.

This is a header - it's big

In general, you can just type away, but there are a number of markers that are nice to know.

If you want to quote something from text, use >:

this is how I would quote some text from another source. This is especially nice if it's a longer quote. Is this long enough? I'm just making up words as I write.

More pound signs mean smaller headers

Below, see my example of writing python code:

print("hello world")

You can also have it apply syntax highlighting of other languages, like java:

System.out.println("hello world")

If you would like to reference keywords inside a sentence, such as for or while, you can use backquotes.

If you would like to insert a link, put the linked text in brackets with the url in parentheses.

Other things

Markdown is also good at lists:

  • for
  • example
  • this

Or numbered lists

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