Cheatsheet for Markdown

Cheatsheet for Markdown

Let's write README.md

ยท

3 min read

Table of contents

No heading

No headings in the article.

Hi Everyone! Welcome back

In this article, we will learn about markdown syntax which helps you in presenting information about GitHub repos to the world. It's a way of presenting the content and sharing relevant metadata. It is not any programming language.

Markdown is written with a syntax of .md . Generally, for GitHub repos README.md is the default name for the markdown.

  • Headings : Markdown provides us six different headings. For respective size of heading we need to add that much number of pound(#) symbol.
# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

1.PNG

  • Bold: Markdown wraps the text around a double asterisk(**) to make the text bold.
**text**

2.PNG

  • Italic: Markdown wraps the text around an asterisk(*) to make the text look slanting.
*text*

3.PNG

  • Blockquote: Text is written after greater than (> ) symbol to display text in a certain block.
> text to be written
> this is a blockquote text. Random text is written to showcase the demo about the bloackquote

4.PNG

  • List : Markdown allows us to write ordered and unordered list

    • Unordered list: Text written after hyphen(- ) is considered as an unordered list item.

       - HTML
       - CSS
       - Javascript
       - Git
      

      5.PNG

    • Ordered list: Text written after specific counting is considered as ordered list item.

      1. HTML
      2. CSS
      3. Javascript
      4. Git
      

      6.PNG

Note: Correct sequence of counting does not matter in ordered list. Markdown takes care of it.

  • Code: To present actual programming language code snippet, write the code within write code here.
for(let i = 0 ; i <= 5 ; i++ ){
    console.log(i)
}
print("Hello World")

7.PNG

To display certain keyword of the programming language, write the code within backticks (keyword here)

`let`

`var`

8.PNG

  • Link: To add any link we use the following syntax:
Syntax: [text](Link address)
[linkedin link](https://www.linkedin.com/in/akshitagarg275/)

[github link](https://www.github.com/in/akshitagarg275/)

9.PNG

  • Image: ** To add any image we use the following syntax:
Syntax: ![text](image path)
![LCO mascot](https://learncodeonline.in/mascot.png)

10.PNG

  • Horizontal rule: Triple hyphens (---) are used to provide horizontal rule.
## This is an image
---

![LCO mascot](https://learncodeonline.in/mascot.png)

11.PNG

  • Strikethrough: Text is wrapped around double tilde (~~ text here ~~) to get a strikethrough.
~~999Rs~~ 299Rs

12.PNG

  • Table: Tables are not recommended in markdown.
Syntax:


| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
| Syntax | Description |
| ----------- | ----------- |
| RollNo | Name |
| 1 | Rahul |
| 2 | Jane |
| 3 | Sam |

13.PNG

These will help you write your markdowns. I hope you enjoyed it.

Do share.

Happy Learning ๐Ÿ‘ฉ

Follow for more

Linkedin Link

Did you find this article valuable?

Support akshita garg's blog by becoming a sponsor. Any amount is appreciated!

ย