Github Issue Markdown

  

This is intended as a quick reference and showcase. For more complete info, see John Gruber's original spec and the Github-flavored Markdown info page.

This cheatsheet is specifically Markdown Here's version of Github-flavored Markdown. This differs slightly in styling and syntax from what Github uses, so what you see below might vary a little from what you get in a Markdown Here email, but it should be pretty close.

Frequently asked questions about MarkdownPad. I want to add this gif to a GitHub flavored markdown file. If it can't be done in GitHub, is it possible to do it in another version of markdown?

Table of Contents

Headers
Emphasis
Lists
Links
Images
Code and Syntax Highlighting
Blockquotes
Inline HTML
Horizontal Rule
Line Breaks

## Headers

H2

H3

Github issue markdown

H4

H5
H6

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

Alt-H2

## Emphasis

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

## Lists
  1. First ordered list item
  2. Another item
  • Unordered sub-list.
  1. 2003 honda pilot transmission replacement cost. Actual numbers don't matter, just that it's a number

  2. Ordered sub-list

  3. And another item.

    Some text that should be aligned with the above item.

  • Unordered list can use asterisks
  • Or minuses
Github Issue Markdown
  • Or pluses
## Links

There are two ways to create links.

Or leave it empty and use the link text itself

Github

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

## Images

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

Github Issue Markdown Template

Inline-style:

Reference-style:

## Code and Syntax Highlighting

Github Markdown Style

Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page.

Inline code has back-ticks around it.

Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.

(Github Wiki pages don't seem to support syntax highlighting, so the above won't be colourful (the strings are not red, for example). Try it out in a Markdown Here email or a Github Markdown README or Github Issue -- you can preview a new Issue without submitting it.)

Again, to see what languages are available for highlighting, and how to write those language names, see the highlight.js demo page.

## Blockquotes

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 putMarkdown into a blockquote.

## Inline HTML

You can also use raw HTML in your Markdown, and it'll mostly work pretty well. Here are a couple of common examples:

Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.
TablesAreCool
ZebraStripesArePretty
HereIsAnotherRow
## Horizontal Rule

Three or more..

Hyphens

Asterisks

Underscores

## Line Breaks

My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once, then hit it twice, see what happens. You'll soon learn to get what you want. 'Markdown Toggle' is your friend.

Here are some things to try out:

With only a single newline, this line andthis line will be a single line.

But this one is separated by two newlines and so will be a separate paragraph.

Github Issue Markdown Free

This line has two spaces at the end (hard for you to see, but trust me!).
So this is a separate line in the same paragraph.