GitHub Markdown Reference
Headers
You can do headers as following
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6Header 1
Header 2
Header 3
Header 4
Header 5
Header 6
Lists
Unordered list
- item
- item
- item- item
- item
- item
Ordered list
1. item
1. item
1. item- item
- item
- item
Nested lists
- item
- sub-item
- sub-sub-item- item
- sub-item
- sub-sub-item
- sub-item
TODOs
- [x] Learn Python
- [ ] Learn Java- Learn Python
- Learn Java
Text Format
*italic*
**bold**
~~strikethrough~~italic
bold
strikethrough
Images
Links
checkout my [website](https://kerolloz.github.io/)checkout my website
Image With link
[](https://imgur.com/gallery/sw215)
Code
this is a small `code` blockthis is a small code block
this is a block of code with syntax highlighting
```python
print("Hello World")
```this is a block of code with syntax highlighting
print("Hello World")Block quote
>look how this renders
look how this renders
>block one
>>nested block
block one
nested block
Table
Notice the colon : place
left aligned | centered | right aligned
-------------|:--------:|--------------:
data | data | data| left aligned | centered | right aligned |
|---|---|---|
| data | data | data |
Horizontal Line
up
---
downup
down
New line
You can make a new line by ending a line with two spaces, you don't have to use <br>.
NOTE
In order to be able to see the effects of the tricks used in the following sections please view it from the website.
Viewing it from GitHub's README won't show the effect!
Definitions
Markdown
: Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.Markdown : Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.
Abbreviations
HTML is easy.
*[HTML]: Hyper Text Markup LanguageHTML is easy.
*[HTML]: Hyper Text Markup Language
Footnote
the book [^1] has good exercises
[^1]: you can find the book on Google.
the book 1 has good exercises
Footnotes
-
you can find the book on Google.
↩