skysoup

Here is an outline of the article. A paragraph is what text will turn into when there is no reason it should become anything else.

GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.

Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.

An exhibit of Markdown!

This note demonstrates some of what Markdown is capable of doing.

Note: Feel free to play with this page. Unlike regular notes, this doesn’t automatically save itself.

Basic formatting

Paragraphs can be written like so. A paragraph is the basic block of Markdown. A paragraph is what text will turn into when there is no reason it should become anything else.

Paragraphs must be separated by a blank line. Basic formatting of italics and bold is supported. This *can be nested like* so.

Lists

Ordered list

Item 1
A second item
Number 3
Ⅳ

Note: the fourth item uses the Unicode character for Roman numeral four.

Unordered list

An item
Another item
Yet another item
And there’s more…

Paragraph modifiers

You can also make inline code to add code into other things.

Quote

Here is a quote. What this is should be self explanatory. Quotes are automatically indented when they are used.

Headings

There are six levels of headings. They correspond with the six levels of HTML headings. You’ve probably noticed them already in the page. Each level down uses one more hash character.

Headings can also contain formatting

They can even contain `inline code`

Of course, demonstrating what headings look like messes up the structure of the page.

I don’t recommend using more than three or four levels of headings here, because, when you’re smallest heading isn’t too small, and you’re largest heading isn’t too big, and you want each size up to look noticeably larger and more important, there there are only so many sizes that you can use.

URLs

URLs can be made in a handful of ways:

A named link to MarkItDown. The easiest way to do these is to select what you want to make a link and hit Ctrl+L.
Another named link to MarkItDown
Sometimes you just want a URL like http://www.markitdown.net/.

Horizontal rule

A horizontal rule is a line that goes across the middle of the page.

It’s sometimes handy for breaking things up.

Images

Markdown can also contain images. I’ll need to add something here sometime.

Finally

There’s actually a lot more to Markdown than this. See the official introduction and syntax for more information. However, be aware that this is not using the official implementation, and this might work subtly differently in some of the little things.

Paragraphs are separated by a blank line.

2nd paragraph. Italic, bold, and monospace. Itemized lists look like:

this one
that one
the other one

Note that — not considering the asterisk — the actual text content starts at 4-columns in.

Block quotes are written like so.

They can span multiple paragraphs, if you like.

Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., “it’s all in chapters 12–14”). Three dots … will be converted to an ellipsis. Unicode is supported. ☺