Text can be bold, italic, or strikethrough.
There should be whitespace between paragraphs.
There should be whitespace between paragraphs. We recommend including a README, or a file with information about your project.
Dark theme
Header 1
This is a normal paragraph following a header. GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
Header 2
This is a blockquote following a header.
When something is important enough, you do it even if the odds are not in your favor.
Header 3
// Javascript code with syntax highlighting.
var fun = function lang(l) {
dateformat.i18n = require('./lang/' + l)
return true;
}
# Ruby code with syntax highlighting
GitHubPages::Dependencies.gems.each do |gem, version|
s.add_dependency(gem, "= #{version}")
end
Header 4 with code not transformed
- This is an unordered list following a header.
- This is an unordered list following a header.
- This is an unordered list following a header.
Header 5
- This is an ordered list following a header.
- This is an ordered list following a header.
- This is an ordered list following a header.
Header 6
head1 | head two | three |
---|---|---|
ok | good swedish fish | nice |
out of stock | good and plenty | nice |
ok | good oreos | hmm |
ok | good zoute drop | yumm |
There’s a horizontal rule below this.
Here is an unordered list:
- Item foo
- Item bar
- Item baz
- Item zip
And an ordered list:
- Item one
- Item two
- Item three
- Item four
And a nested list:
- level 1 item
- level 2 item
- level 2 item
- level 3 item
- level 3 item
- level 1 item
- level 2 item
- level 2 item
- level 2 item
- level 1 item
- level 2 item
- level 2 item
- level 1 item
Nesting an ol in ul in an ol
- level 1 item (ul)
- level 2 item (ol)
- level 2 item (ol)
- level 3 item (ul)
- level 3 item (ul)
- level 1 item (ul)
- level 2 item (ol)
- level 2 item (ol)
- level 3 item (ul)
- level 3 item (ul)
- level 4 item (ol)
- level 4 item (ol)
- level 3 item (ul)
- level 3 item (ul)
- level 1 item (ul)
And a task list
- Hello, this is a TODO item
- Hello, this is another TODO item
- Goodbye, this item is done
Small image
Large image
Definition lists can be used with HTML syntax.
- Name
- Godzilla
- Born
- 1952
- Birthplace
- Japan
- Color
- Green
Multiple description terms and values
- Term
- Brief description of Term
- Longer Term
- Longer description of Term, possibly more than one line
- Term
- First description of Term, possibly more than one line
Second description of Term, possibly more than one line
- Term1
- Term2
- Single description of Term1 and Term2, possibly more than one line
- Term1
- Term2
- First description of Term1 and Term2, possibly more than one line
Second description of Term1 and Term2, possibly more than one line
More code
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
The final element.
Callouts
The configuration of the callouts shown below is in _config_tests.yml
.
Admonition
A paragraph
Attention
A paragraph
Caution
A paragraph
Custom
A paragraph
Danger
A paragraph
Error
A paragraph
Highlight
A paragraph
Hint
A paragraph
Important
A paragraph
Note
A paragraph
Tip
A paragraph
Warning
A paragraph
Multi-paragraph callouts
A paragraph
Another paragraph
The last paragraph
Indented callouts
A paragraph
Indented multi-paragraph callouts
A paragraph
Another paragraph
The last paragraph
Nested callouts
A paragraph
With opaque background (using HTML):
A paragraph