Exile1201 / markdown

a reference (guide) on how to write good GitHub markdown for READMEs or any .md file!

Headers

You can do headers as following

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Header 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

1. item
2. item
3. item

---

Nested lists

- item
  - sub-item
    - sub-sub-item

• item
  • sub-item
    • sub-sub-item

Text Format

*italic*
**bold**
~~strikethrough~~

italic
bold
strikethrough

Images

![Alternative text here](https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/1280px-Markdown-mark.svg.png)

Links

checkout my [website](https://kerolloz.github.io/)

checkout my website

Code

this is a small `code` block

this is a small code block

---

this is a block of code
```python
print("Hello World")
```

this is a block of code

print("Hello World")

Block quote

>look how this renders

look how this renders

---

>block one
>>nested block

block one

nested block

Horizontal Line

up

---

down

up

---

down

New line

You can make a new line by ending a line with two or more spaces you don't have to use <br>

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 Language

HTML is easy.

*[HTML]: Hyper Text Markup Language

Footnote

the book [^1] has good exercises

[^1]: you can find the book on Google.

the book ¹ has good exercises

Footnotes

1. you can find the book on Google. ↩