Skip to content

Instantly share code, notes, and snippets.

@shmup
Forked from james2doyle/markdown-cheatsheet.md
Created October 22, 2016 04:02
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save shmup/56e109c330d05fd0982212f56d58e019 to your computer and use it in GitHub Desktop.
Save shmup/56e109c330d05fd0982212f56d58e019 to your computer and use it in GitHub Desktop.
Another markdown cheatsheet. More straightforward examples.

Any block of text surrounded by line breaks is considered a paragraph.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Alternatively, for H1 and H2, an underline-ish style:

Alt-H1

Alt-H2

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

  1. First ordered list item
  2. Another item
  • Unordered sub-list.
  1. Actual numbers don't matter, just that it's a number

  2. Ordered sub-list

  3. 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.⋅⋅ (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

I'm an inline-style link

I'm an inline-style link with title

[I'm a reference-style link][Arbitrary case-insensitive reference text]

I'm a relative reference to a repository file

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself]

Some text to show that the reference links can follow later.

Here's our logo (hover to see the title text):

Inline-style:

alt text

Reference-style:

![alt text][logo]

Inline code has back-ticks around it.

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

No language indicated, so no syntax highlighting in Markdown Here (varies on Github).

But let's throw in a tag.

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

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

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.

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.

Three or more...


Hyphens


Asterisks


Underscores

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.

IMAGE ALT TEXT HERE

Normal Image

IMAGE ALT TEXT HERE

Image In Link

IMAGE ALT TEXT HERE

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