redduxi/awesome-readme-markdown

Markup readme

Awesome-Readme_Markup

Table of Contents

1. Headers
2. Text Selection
3. Lists
   1. Numbered list
   2. Bulleted list
   3. Task list
   4. Dropdown list
4. Links
5. Badges
6. Buy me a coffe
7. Images
8. Gif
9. Tables
10. Quotes
11. Footnote
12. Code Blocks
13. Ignore Markdown Formatting
14. Emoji
15. GitHub stats
16. Markdown Editors
17. Others resources

Headers

H1

# H1

H2

## H2

H3

### H3

H4

#### H4

H5

##### H5

H6

###### H6

H1

H1
=

H2

H2
-

Text selection

asterisk italic

*italic*

underline sign italic

_italic_

asterisk bold

**bold**

underline sign bold

__bold__

italic and bold

*italic and __bold__*

crossed out text

~~crossed out text~~

code highlight

`code highlight`

This is _subscript!

This is <sub>subscript!</sub>

This is ^superscript!

This is <sup>superscript!</sup>

Lists

numbered list:

1. one

2. two

   indentations

3. three

numbered list:
1. one
2. two
[space][space][space]indentations
3. three

multilevel numbered list:

1. level 1
   1. level 2
2. level 1
   1. level 2
   2. level 2
      1. level 3

multilevel numbered list:
1. level 1
[4 spaces]1. level 2
2. level 1
[4 spaces]1. level 2
[4 spaces]2. level 2
[8 spaces]1. level 3

bulleted list:

• one

• two

• three

bulleted list:
+ one
- two
* three

multilevel bulleted list:

• level 1
  • level 2
• level 1
  • level 2
  • level 2
    • level 3

multilevel bulleted list:
- level 1
[4 spaces]- level 2
- level 1
[4 spaces]- level 2
[4 spaces]- level 2
[8 spaces]- level 3

Task list:

• todo 1
• todo 2
• todo 3
• todo 4
  • todo 4.1
  • todo 4.2

Task list:
- [ ] todo 1
- [x] todo 2
- [x] todo 3
- [ ] todo 4
	- [ ] todo 4.1
	- [ ] todo 4.2

Dropdown list

language

Java
C++
C#

<details open>
<summary>language</summary>
Java<br>
C++<br>
C#
</details>

language

• Java
• C#
• C++

<details>
<summary>language</summary>
<ul>
<li>Java</li>
<li>C#</li>
<li>C++</li>
</ul>
</details>

print('Hello world!')

Show markdown

```python
print('Hello world!') ```

Links

Link to GitHub

[Link to GitHub](https://github.com/)

Link to GitHub with title

[Link to GitHub with title](https://github.com/ "GitHub")

Reference to a repository file

[Reference to a repository file](../file)

https://github.com

<https://github.com>

[email protected]

<[email protected]>

Link to GitHub

**[Link to GitHub](https://github.com)**

Link to GitHub

*[Link to GitHub](https://github.com)*

Images

![GitHub](https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png)

[![GitHub](https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png)](https://github.com/)

![alt text][logo]

[logo]:https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png

<img src="https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png" height="100" />

Left align

<img align="left" width="100" height="100" src="https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png">

Rigth align

<img align="right" width="100" height="100" src="https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png">

Center align

<p align="center">
<img width="100" height="100" src="https://cdn0.iconfinder.com/data/icons/social-network-9/50/29-512.png">
</p>

Gif

![Gif](https://giffiles.alphacoders.com/398/3987.gif)

If you want add video into readme you can convert him to gif format.

Badges

[![Build][awesome-image]][awesome-url]

[awesome-url]: https://github.com/redduxi/Awesome-Readme-Markdown/
[awesome-image]: https://p.kindpng.com/picc/s/736-7368452_grunge-awesome-label-psd-graphic-design-hd-png.png

[![CircleCI](https://circleci.com/gh/circleci/circleci-docs.svg?style=svg)](https://github.com/redduxi/Awesome-Readme-Markdown/)

💫 See other budges 💫 Version Badge

Buy me a coffe

Buy me a coffe

Tables

LEFT	CENTER	RIGHT
................	................	................

|        LEFT       |      CENTER      |       RIGHT      |
|:------------------|:----------------:|----------------: |
|  ................ | ................ | ................ |

italic	bold
text	text

italic | bold
---    | ---
*text* | **text**

HTML table syntax into Markdown

Tables Generator

Quotes

Lorem Ipsum is simply dummy text of the printing and typesetting industry.

> Lorem Ipsum is simply dummy text of the printing and typesetting industry.

Lorem Ipsum is simply dummy text of the printing and typesetting industry.

> > Lorem Ipsum is simply dummy text of the printing and typesetting industry.

Lorem Ipsum is simply dummy text of the printing and typesetting industry.

Lorem Ipsum is simply dummy text of the printing and typesetting industry.

> Lorem Ipsum is simply dummy text of the printing and typesetting industry.
>
> Lorem Ipsum is simply dummy text of the printing and typesetting industry.

Lorem Ipsum

• What is Lorem Ipsum?

  Lorem Ipsum is simply dummy text of the printing and typesetting industry.

• Why do we use it?

  Used to fill pages and test the appearance of layouts

> ### Lorem Ipsum
>
> - What is Lorem Ipsum?
>
> 	Lorem Ipsum is simply dummy text of the printing and typesetting industry.
> - Why do we use it?
> 	
> 	 Used to fill pages and test the appearance of layouts

Footnote

Footnote<sup>1</sup>

Footnote<sup>2</sup>

Footnote<sup>1</sup>

Footnote<sup>2</sup>

Lorem Ipsum <sup>1</sup>

1 Lorem Ipsum is simply dummy text of the printing and typesetting industry. ↩

Lorem Ipsum <sup id="lorem">[1](#Footnote1)</sup>
<b id="Footnote1">1</b> Lorem Ipsum is simply dummy text of the printing and typesetting industry. [↩](#lorem)

Code Blocks

 #include <iostream> 
 ///
 int main(){///}

```c++
#include <iostream> 
///
int main(){///}
```(used without brackets)

Ignore Markdown formatting

Lorem Ipsum is simply *dummy* text of the printing and *typesetting industry*.

Lorem Ipsum is simply \*dummy\* text of the printing and \*typesetting industry\*.

Emoji

😄 I use emoji

💫 Complete list of github markdown emoji markup

GitHub stats

<img src="https://github-readme-stats.vercel.app/api?username=redduxi&show_owner=true&show_icons=true&theme=dark">

💫 GitHub Readme Stats

Includes:

• GitHub Stats Card
• GitHub Extra Pins
• Top Languages Card
• Wakatime Week Stats
• Themes
• Customization

Markdown Editors

• Markdown editor
• Bywor‪d‬
• Ulysse‪s‬
• MacDown
• Caret
• Typora
• Haroopad
• HackMD
• StackEdit
• Dillinger

Other resources

• Awesome README
• GitHub Flavored Markdown Spec

😉 💞