A complete guide for Markdown files

The only Markdown guide you need

9 October, 2022

Contributors

Susmita Dey

@susmitadey

According to Wikipedia:

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown is widely used in blogging, instant messaging, online forums, collaborative software, documentation pages, and readme files.

A markdown file has .md extension and we can write and design text or useful information by following the basic syntaxes. It's very popular and easy to use.

HTML tags are also supported in markdown.

Use Case

Markdown syntax is used in various popular places nowadays. You can also make websites using markdown files. This can be done using docsify.

Some popular platforms that use Markdown syntaxes and files are as follows -

•

GitHub

•

Hashnode

•

Dev.to

•

Discord and many other platforms.

Basic Syntaxes

Headings

Syntax:

Output:

H1 - Heading 1

H2 - Heading 2

H3 - Heading 3

H4 - Heading 4

H5 - Heading 5

H6 - Heading 6

Code

This can be written in 2 ways - Inline code and normal code

Syntax for inline code:

Output: Hello World

Syntax for normal code:

Output:

Unordered List of Items

Syntax:

Output:

•

Milk

•

Tea

•

Beer

Syntax:

This is an alternate syntax to create unordered list items.

Output:

•

JavaScript

•

TypeScript

•

ReactJs

Ordered List of Items

Syntax:

Output:

Eat

Walk

Sleep

CheckBox Task List

Syntax:

Output:

Markdown checkboxes

Code Block

Syntax:

Output:

In order to highlight the code, you can add language name at the start of the backticks as in the following examples.

Example 1:

Output:

Example 2:

Output:

Strikethrough Text

Syntax:

Output:

Work all day without taking rest.

Blockquote Text

Syntax:

Output:

“I'm unpredictable, I never know where I'm going until I get there, I'm so random, I'm always growing, learning, changing, I'm never the same person twice. But one thing you can be sure of about me; is I will always do exactly what I want to do.”

Bold

Syntax:

Output:

DO NOT UNDERESTIMATE THE POWER OF A PROGRAMMER.

Random bollywood meme from a random website

Italic

Syntax:

Output:

It is Written in Italics

Bold and Italic

Syntax:

Output:

You Can Combine Bold and Italics

Syntax:

Output:

Did you know I have a stress-relieving Website?

Image

Syntax:

Output:

Linking an Image

Syntax:

Output:

Emojis

Syntax:

Output:

🥭 🍋 👨 🚗

Table

Syntax:

Output:

Fruit	Emoji
Mango	🥭
Lemon	🍋

Syntax:

Output:

Fruit(left)	Emoji(center)	Taste(right)
Mango is the king of Fruits	🥭	Sweet and I love it
Lemon is good for health	🍋	Sour, mix it in the water

Horizontal Line

Syntax:

Output:

HTML

Syntax:

Output:

Yes, you can use allowed raw HTML in https://www.youtube.com/watch?v=ME3_uchWv8kmark-down file. This is a paragraph aligned in the center.

Embed YouTube Video

Syntax:

Output:

Embed GIF

Syntax:

Output:

Mathematical Expressions

Inline expressions:

Syntax

 $<<mathematical expression>>$

Replace <<mathematical expression>> with your expression.

Example

 $\sqrt{3}+1$

Output

Block Expressions:

Syntax

 $$<<mathematical expression>>$$

Example

 $$\sqrt{3}+1$$

Output

Mixed Expressions:

Syntax

 When $a \ne 0$, there are two solutions to $(ax^2 + bx + c = 0)$ and they are $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$

Output

For more information on how to write mathematical expressions, visit this page.

Conclusion

This is a comprehensive list for you all as your guide. Hope all went well and you enjoyed the article.

More powers to you. 💪

https://giphy.com/gifs/jackiejameswhiskey-good-luck-crossing-fingers-cross-287U9qQH5vrKg7KYSH

Hope this helps you. Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my YouTube Channel and connect on LinkedIn or Twitter. Also, feel free to support my work.😊

hacktoberfest

A complete guide for Markdown files

Use Case

Basic Syntaxes

Headings

H1 - Heading 1

H2 - Heading 2

H3 - Heading 3

Code

Unordered List of Items

Ordered List of Items

CheckBox Task List

Code Block

Strikethrough Text

Blockquote Text

Bold

Italic

Bold and Italic

Image

Linking an Image

Emojis

Table

Horizontal Line

HTML

Embed YouTube Video

Embed GIF

Mathematical Expressions

Conclusion

Hope this helps you. Thank you for reading, and let's connect!

More Articles