GitHub Markdown Reference

Headers

# 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

item
item
item

Nested lists

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

item
- sub-item
  - sub-sub-item

TODOs

- [x] Learn Python
- [ ] Learn Java

Learn Python
Learn Java

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

Image With link

[![image alt text](https://i.imgur.com/sw215.jpeg)](https://imgur.com/gallery/sw215)

Code

this is a small `code` block

this is a small code block

This is a block of code with syntax highlighting:

```python
print("Hello World")
```

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

---

down

down

New line

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

Note, Warning, and Tip

> [!NOTE]
> This is a note

> [!WARNING]
> This is a warning

> [!TIP]
> This is a tip

> [!IMPORTANT]
> This is important

> [!CAUTION]
> This is a caution

Becomes:

Note

This is a note

Warning

This is a warning

Tip

This is a tip

Important

This is important

Caution

This is a caution

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 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

you can find the book on Google. ↩

kerolloz / markdown Goto Github PK

markdown's Introduction