Shreesha H R's blog

Markdown Cheat sheet

Shreesha H R's photo
Shreesha H R
·

3 min read

As a software engineers, everyone must have at least heard about the markdown file or the readme.md file in Github. In simple words Markdown file is the simple text file which contains the details or the documentation of the project. Let's make a quick tour on how to effectively write the Markdown file. Let's get started.

Headings

Headings focus the reader on the most important content in a piece of writing. There are six headings ranging from H1 up to H6 based on sizing.

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Output

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

NOTE : There should be a space between # Heading. #Heading doesn't make it a heading.

Text Decorations

Text decorations is generally used to decorate a text.


This is a text without any text decorations

 **Bold**

_Italic_

~~Strike Through~~

Output

This is a text without any text decorations

Bold

Italic

Strike Through

Lists

These are used to list the items. The two types of lists are :-

Ordered List


1. This is ordered list item 1
  1. This is nested ordered list
2. This is another list item 2

Output

  1. This is ordered list item 1
    1. This is nested ordered list
  2. This is another list item 2

Unordered List


- This is unordered list item 1
  -This is nested list item
- This is unordered list item 2

Output

  • This is unordered list item 1 -This is nested list item
  • This is unordered list item 2

#Links

Here we can embed the link of different websites for the easy access.


[Markdown Cheatsheet](https://shreesha.hashnode.dev "Shreesha's Blog")

Output

[Markdown Cheatsheet](shreesha.hashnode.dev "Shreesha's Blog")

Link your Images

We can also link the required images through the below mentioned method.


![LCO](https://learncodeonline.in/mascot.png "Title is optional")

Output

![LCO](learncodeonline.in/mascot.png "Title is optional")

Here we can also upload the images which are in our local machine by specifying the relative path like ./assets/logo.png.

Block Quote

Block quote is specifically used to highlight the specific line. > symbol is used to specify block quote.


>This line is written using block quote
>
>> This is nested block quote

Output

This line is written using block quote

This is nested block quote

Foldable texts

Foldable texts help condense large blocks of text allowing site viewers to quickly navigate to the most relevant information.


<details>
    <summary>India</summary>
    <p>Delhi</p>
    <p>Punjab</p>
    <p>Haryana</p>
    <p>Karnataka</p>
</details>

Output

India

Delhi

Punjab

Haryana

Karnataka

Line Breaks

This usually resembles the end of a paragraph or line. This puts a horizontal line where it is specified. *** symbol is used to put line breaks.


***

Output

So that's it for this blog. Hope you enjoyed my very first blog.

All the feedbacks are appreciated. Thank you.

cheatsheetmarkdownmarkdown cheat sheetREADMEreadme.md