Markdown is extremely important, especially when contributing to open source. It is used by a variety of sites such as Github for README’s, Issues, Pull-Requests, etc.
In this post, I will explain some basic markdown syntaxes such as adding images, notes/tips/warning, checklists, etc.
HEADINGS:
TOPIC
# TITLE HERE
SUB-TOPIC:
## SUB-TOPIC HERE
SUB-SUB-TOPIC:
### SUB-SUB-TOPIC HERE
TEXT FORMAT:
BOLD:
**BOLD TEXT HERE**
ITALIC:
*ITALIC TEXT HERE*
UNDERLINE:
<u>UNDERLINE TEXT HERE</u>
HYPERLINK:
[HYPERLINK TEXT HERE](LINK HERE)
IMAGE:
DROPDOWN:
<details>
<summary>
DROPDOWN TEXT HERE
</summary>
<summary>
DROPDOWN TEXT HERE
</summary>
DROPDOWN CONTENT HERE
</details>
IMPORTANT MESSAGES:
TIP:
> [!TIP]
> TIP CONTENT HERE
> TIP CONTENT HERE
WARNING:
> [!WARNING]
> WARNING CONTENT HERE
> WARNING CONTENT HERE
IMPORTANT:
> [!IMPORTANT]
> IMPORANT CONTENT HERE
> IMPORANT CONTENT HERE
NOTE:
> [!NOTE]
> NOTE CONTENT HERE
> NOTE CONTENT HERE
Thanks for reading
Hopefully you have found this blog helpful!!