# Github Markdown Example

GITHUB FLAVORED MARKDOWN GitHub.com uses its own version of the Markdown syntax, GFM, that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com. USERNAME ˜MENTIONS Typing an @ symbol, followed by a username, will notify that person to come and view the comment. Given that this page is offered as the primary example linked from the GitHub Flavored Markdown page, it would be great if it rendered correctly. So thanks to the wonderful fact that comments themselves use this very markdown, I've included a c&p of the corresponding referenced source (with the exception of the following minor fix, s/ example which appears to be indicative.

A collection of Markdown code and tricks that were tested to work in Gist.

This and all public gists in https://gist.github.com/ww9 are Public Domain. Do whatever you want with it including , no need to credit me.

### Todo

• Reformat this whole document and assimilate these:
• https://gist.github.com/t-nissie/9580883 (Add images, secret gists, anti-spam protection)
• https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e#file-mathjax-ipynb (Python notebook, Math syntax)

Result:

### Collapsible content (spoilers)

Content between <details> and </details> is hidden. You need to escape HTML tags them.

## H2

### H3

#### H4

##### H5
###### H6

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

## Emphasis

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.

## Lists

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.

Some text that should be aligned with the above item.

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

There are two ways to create links.

Or leave it empty and use the link text itself

URLs and URLs in angle brackets will automatically get turned into links.http://www.example.com or http://www.example.com and sometimesexample.com (but not on Github, for example).

## Images

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

Inline-style:

Reference-style:

## Code and Syntax Highlighting

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.

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

## Tables

Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application.

Colons can be used to align columns.

TablesAreCool
col 3 isright-aligned$1600 col 2 iscentered$12