DEV Community

Cover image for Basic Markdown
Hemang Yadav
Hemang Yadav

Posted on

Basic Markdown

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
Enter fullscreen mode Exit fullscreen mode

SUB-TOPIC:

## SUB-TOPIC HERE
Enter fullscreen mode Exit fullscreen mode

SUB-SUB-TOPIC:

### SUB-SUB-TOPIC HERE
Enter fullscreen mode Exit fullscreen mode

TEXT FORMAT:

BOLD:

**BOLD TEXT HERE**
Enter fullscreen mode Exit fullscreen mode

ITALIC:

*ITALIC TEXT HERE*
Enter fullscreen mode Exit fullscreen mode

UNDERLINE:

<u>UNDERLINE TEXT HERE</u>
Enter fullscreen mode Exit fullscreen mode

HYPERLINK:

[HYPERLINK TEXT HERE](LINK HERE)
Enter fullscreen mode Exit fullscreen mode

IMAGE:

![IMAGE DESCRIPTION HERE](IMAGE DIRECTORY HERE)
Enter fullscreen mode Exit fullscreen mode

DROPDOWN:

<details>
<summary>
DROPDOWN TEXT HERE
</summary>

DROPDOWN CONTENT HERE

</details>
Enter fullscreen mode Exit fullscreen mode

IMPORTANT MESSAGES:

TIP:

> [!TIP]
> TIP CONTENT HERE
Enter fullscreen mode Exit fullscreen mode

WARNING:

> [!WARNING]
> WARNING CONTENT HERE
Enter fullscreen mode Exit fullscreen mode

IMPORTANT:

> [!IMPORTANT]
> IMPORANT CONTENT HERE
Enter fullscreen mode Exit fullscreen mode

NOTE:

> [!NOTE]
> NOTE CONTENT HERE
Enter fullscreen mode Exit fullscreen mode

Thanks for reading

Hopefully you have found this blog helpful!!

Top comments (0)