DEV Community

Cover image for Everything you need to know about Markdown
Ganesh Patil
Ganesh Patil

Posted on

Everything you need to know about Markdown

Introduction

Markdown is a lightweight markup language that is used for creating and formatting text using a plain-text editor. Markdown is the fastest and easiest way to format plain text using special markdown characters like hashtags, dashes, underscores, etc.
We can also create code blocks, headers, lists, and other things with the help of markdown. Markdown is the best way to explain and describe the working flow of the project.

The GitHub projects or while creating a GitHub repository need to create a Readme file which basically uses a markdown to write a markdown is not only use for writing a readme file but the most popular blogging platforms provide features for users to use markdown for writing a blog. It's very important to know how to use markdown as a developer or as a technical person.

1.Headings: Headings are used to declare the title of the document, there are six heading tags are available in the markdown from #h1, #h2, #h3,#h4,#h5 and #h6.

// Heading 1
Image description

Hashnode

2.Bold Text: Formatting text is pretty easy in markdown if you want to make text bold then simply use inside text and for italic inside text and if you want to make text bold with italic then used inside text and it's done.

Image description

Hashnode with bold text

Image description

Hashnode with bold & italic text

3.Blockquote: Blockquote is used to show an essential section of the document or file.

Image description

Hashnode is an awesome platform

4.Strikethrough: It is used to show mistaken text in the document or process which is not important to follow and to use strikethrough used hashnode

Image description

Image description

5.Lists: Lists are used to show steps or instructions to follow step by step and lists are two types ordered lists and unordered lists easy-to-use lists in markdown. Example of an ordered list

Image description

output

  1. Item 1
  2. Item 2
  3. Item 3

6.Unordered List: There are multiple ways to create an unordered list you can use a dash(-), an asterisk(*), and (+) to create an unordered list.
Example

Image description

Output

. Item 1

. Item 2

. Item 3

7.Links with Title:

Image description

Visi to my Hashnode Profile

Image with Link

Image description

Image description

8.Code Blocks:
Code blocks are used to create code snippets it will help the user to understand the code as compared to explaining code with only text to create code blocks using backticks(

code

)for single-line code used ( singe line code here ).

Create Code blocks

Image description

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>HTML 5 Boilerplate</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <script src="index.js"></script>
  </body>
</html>
Enter fullscreen mode Exit fullscreen mode

Code block with Syntax highlighting

Image description

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>HTML 5 Boilerplate</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <script src="index.js"></script>
  </body>
</html>
Enter fullscreen mode Exit fullscreen mode

you need to specify the language you want to use as per above example I specified the html language you can choose as per your requirements.

9.Tables
Tables are used to describe data in form of rows and columns and how to create them in markdown let's see with the example is given below

Image description

Image description

Note: At least 3 dashes separate each header cell.

10.Task Lists
By keeping such a list, you make sure that your tasks are written down all in one place so you don't forget anything important.

Image description

Image description

That’s all about markdown there are much more things available that you can do with markdown to create better documentation and Readme files.
Hey, I'm Ganesh πŸ–
I write articles on web development and share valuable resources which might help you as a developer or beginner.

  • follow me for more content
    Ganesh_Patil

  • if this article add values to you then you can buy coffee for me!

  • You can also connect with me on Twitter
    to get more content related to web development
    thank you for the support! ✌

Discussion (0)