Some renderers support linking to headers with ids.
Link to headings with custom ids via a standard link with a pund sign followed by the custom heading ID.
Paragraphs are separated by blank lines.
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.
Begin each line with two spaces or more to make text look e x a c t l y like you type i t.
Footnotes will be added to the bottom of the document, with a link back to the original reference
I have more to say up here. 1
This text is italic
This text is also italic
This text is bold
This text is also bold
Combined emphasis with asterisks and underscores.
This text is strikethrough
This is a block quote.
More
This is a block quote with multiple paragraphs
Simply include the a blank line with a leading greater than symbol.
Quoting continued
Nested quotes are allso possible.
The double symbol will do ya.
More quoting
Blockquotes can include some of the other elements.
- bullet points
And even emphasis
I'm a relative reference to a repository file
You can use numbers for reference-style link definitions
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 sometimes example.com (but not on Github, for example).
- First ordered list item
- Another item
- Actual numbers don't matter, just that it's a number
- Nested ordered list requires 4 leading spaces
- And another item
- Unordered list can use asterisks
- And require two leading spaces when nested
Inline code has back-ticks around it.
Blocks of code are either fenced by lines with three back-ticks ``` (preferred), or are indented with four spaces.
var s = "Specifies language for renderers with syntax highlighting";
alert(s);s = "Python with syntax highlighting if supported"
print sNo language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
You can cheat by using the table generator.
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 |
There must be at least 3 dashes separating each header cell. 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 |
When supported, render with checkboxes.
- Task 1
- Completed item
- Not completed item
GitHub.com uses its own version of the Markdown syntax that provides an additional set of features.
Footnotes
-
To say down here. This can be a block with paragraphs,
codeand all the things. ↩