README.md

🚀 Welcome! Markdown Complete Guide 4 README.md

Start improving your README's with this guide.

⭐If you liked this repository, please give it a star

 

How this repository will be shown?

1. How to do it (with Markdown)
2. Preview

Menu (not remissive yet)

• Welcome

• How it will be shown

• Guide

  • 🧱Fundamentals
  • 📐Structure and Layout
  • 🔍Advanced
  • 🧩Renderers and Compatibility
  • ⛔Bad habits to avoid

• How to Contribute

🧱 1. Fundamentals

1.1 Titles (#)🔝

# Title 1
## Title 2
### Title 3
#### Title 4
##### Title 5
###### Title 6

Title 1

Title 2

Title 3

Title 4

Title 5

Title 6

1.2 ✍️ Emphasis🔝

*italic* ou _italic_  
**bold** ou __bold__  
***bold + italic***  
~~erased~~

italic ou italic
bold ou bold
bold + italic
erased

1.3 🗒️ Lists🔝

Unordered

- Item
* Item
+ Item

• Item

• Item

• Item

Ordered

1. Item
2. Item 2
   1. Subitem

1. Item
2. Item 2
   1. Subitem

Checkboxes

- [x] Done
- [ ] To do

• Done
• To do

Note

The x must be put only in the tasks you've already done

1.4 🔗 Links🔝

[Google](https://google.com)

Google

1.5 🖼️ Images🔝

![Alt text](https://via.placeholder.com/100)

1.6 💻 Code🔝

Inline

Note

Inside `

Use `npm install`

How it will be shown:
Use npm install

Code block

Note

Inside ```

```
block of code here
```

How it will be shown:

block of code here

With language (Python for example)

```Python
def hello():
    print("Hello World!")
```

How it will be shown:

def hello():
    print("Hello World!")

Before and after (changes made)

```diff
  - def hello():
  + def hi():
      print("Hello World!")
```

How it will be shown:

- def hello()
+ def hi():
  print("Hello World!")

📐 2. Structure and Layout

2.1 📊 Tables🔝

| Name  | Age | Role     |
|-------|------:|-----------|
| Name 1  | 24    | Backend developer |
| Name 2 | 32    | Fullstack developer   |

Name	Age	Role
Name 1	24	Backend developer
Name 2	32	Fullstack developer

Important

:---: -> aligned to the center
---: -> aligned to the right
:--- -> left aligned

2.2 ➖ Horizontal line🔝

Note

All 3 do the same thing

___
---
***

---

---

---

2.3 💬 Quotes🔝

> This is a quote.
>> Subquote

This is a quote.

Subquote

2.4 💬 Different types of Quotes🔝

> [!IMPORTANT]\
> This is a important quote

> [!WARNING]\
> This is a quote that warns the person

> [!NOTE]\
> This is just a quote that expresses a note

Important

This is a important quote

Warning

This is a quote that warns the person

Note

This is just a quote that expresses a note

🔍 3. Advanced

3.1 ❗ Character Escaping🔝

\*not italic\*

*not italic*

3.2 📁 Collapsible (GitHub only)🔝

<details>
  <summary>Show</summary>
  Hidden text
</details>

Show

Hidden text

3.3 😄 Emojis🔝

:sparkles: :tada: :rocket:

✨ 🎉 🚀

Note

You can check all the emojis available at the present moment here: Emoji-Cheat-Sheet repository by ikatyang

3.4 🧭 TOC (Table of Contents)🔝

- [Fundaments](#1-fundaments)
- [Structure](#2-structure-and-layout)

• Fundaments
• Structure

3.5 🕵️ Comments (not visible)🔝

<!-- this is a comment -->

3.6 ➗ Math formulas🔝

$E = mc^2$

$E = mc^2$

$$
\frac{a}{b} = c
$$

$$ \frac{a}{b} = c $$

🧩 4. Renderers and Compatibility

Plataform	Tables	Emojis	Math	Mermaid	HTML
Github	✅	✅	❌	✅	✅
Obsidian	✅	✅	✅	✅	⚠️
Typora	✅	✅	✅	✅	✅
VS Code	✅	✅	✅	⚠️	✅

❌ 5. Bad habits to avoid

• ❌ Titles with **bold**
• ❌ Mix ordered with unordered lists
• ❌ Using advanced HTML inside a Markdown document
• ❌ Links without proper text

---

✏ How to contribute🔝

If you want to contribute to this repository you can fork it and make a pull request or open an issue!

Warning

Forks, pull requests, and issues are intended solely to enhance this repository for the benefit of the community. Any inappropriate or disrespectful activity will be reported accordingly.