tsotneforester / markdownguide

🔰 Master Markdown Syntax & Create Awesome READMEs ✨

Perosnal Guide of
Readme Markdown Syntax

Table of Contents

Header
Emphesize
Line
List
Link
Image
Table
Checkbox
Footnote
Quote
Alert
Resources

Header

# Heading 1 (with underline)
## Heading 2 (with underline)
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

<h1 align="center">This is `true`</h1>

Emphesize

italic	bold	italic + bold	Strikethrough
_italic_	__bold__	_**table**_	~~Strikethrough
*italic*	**bold**	__*table*__

<strong>bold</strong>
<b>bold</b>

<em>italic</em>
<i>italic</i>

Line

<hr />
---
***
___

List

- item
- item

1. item 1
2. item 2 

Link

[hi](link)
<https://www.markdownguide.org>

[My GitHub][GitHubLink]
[GitHubLink]:https://github.com/darsaveli

Image

 <p align="center"><img align="center" width="165px" title="Winnie-the-Pooh" src="https://github.com/darsaveli/Mariam/blob/main/1479814528_webarebears.gif"></p>

![alt](src "title")
[![alt](src "title")](link)

Table

| name | surname | age |
| :--- | :-----: | --: |
| 4    | 5       | 6   |

Checkbox

* [ ] Checkbox1
* [ ] Checkbox2
* [x] Checkbox selected

Footnote

Here is a simple footnote[^1].
[^1]: My reference.

Quote

> blockquote1
> > blockquote2
> > > blockquote3

blockquote1

blockquote2

blockquote3

Alerts

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

>[!NOTE]/[!TIP]/[!IMPORTANT]/[!WARNING]/[!CAUTION]
>Advises about risks or negative outcomes of certain actions.

Resources

Terminal gif
Typing svg
GitHub Summary
GitHub Stats
Skill Icons
Shields.io 1
Shields.io 2
Official Github Blog for Markdown
Emoji

(back to top)