/Markdown-language

This repository contains a cheat sheet on Markdown Language.

MIT LicenseMIT

What is Markdown Language?

Markdown is a lightweight markup language. It is used to create formatted text using simple text editor.

Github supports Markdown and thats why we are going to create this documentation in .md file.

  • Content:
    • Basic syntax.
    • Advanced syntax.

-----------------------------------------------------

Basic Syntax :

  • HEADERS (H1 to H6)

#  h1 tag
##  h2 tag
###  h3 tag

Output

h1 tag

h2 tag

h3 tag

-----------------------------------------------------

  • EMPHASIS

*This is italic*
_This is also italic_
**This is bold**
__This is also bold__

Output

This is italic

This is also italic

This is bold

This is also bold -----------------------------------------------------

  • BLOCKQUOTES

> this is a single block quote.
>> this is a nested block quote.

Output

this is a single block quote.

this is a nested block quote.

-----------------------------------------------------

  • LIST

  • Ordered List :

 1. First item
 2. Second item

Output

  1. First item
  2. Second item

  • Unordered List :

 - First item
  - Second item

Output

  • First item
    • Second item

-----------------------------------------------------

  • Table

| topic       | Description |
| ----------- | ----------- |
| text1       | Text 2      |
| text3       | Text 4      |

Output

topic Description
text1 Text 2
text3 Text 4

-----------------------------------------------------

  • Check Box:

 - [ ] task 1
 - [x] task 2

Output:

  • task 1
  • task 2

-----------------------------------------------------

  • HORIZONTAL RULE

---

Output

-----------------------------------------------------

  • Code

  `This is a code`

Output

This is a code

More Examples :

Highlighted C Codes:

  ```c
  Printf("Hello World!");

Output

Printf("Hello World!");

Highlighted HTML Codes:

  ```html
  <!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>Document</title>
</head>
<body>

</body>
</html>

Output

<!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>Document</title>
</head>
<body>

</body>
</html>

-----------------------------------------------------

  • LINK

Normal link Syntax:
[title](https://www.example.com)

Example:
[Github](https://www.github.com)

Emails Syntax:
<email id>

Example:
<xyz@gmail.com>

Output :

Github

xyz@gmail.com

-----------------------------------------------------

  • IMAGES

Syntax:
![image name](image address)

Example:
![github-octocat](https://user-images.githubusercontent.com/87390353/139872522-9706b6aa-06cf-480f-b26d-0b7e0aaa7214.png)

Output :

github-octocat

-----------------------------------------------------

Advanced Syntax :

  • EMOJI

Syntax:  :short code:
Example : :laughing:

Output :

😆

-----------------------------------------------------

  • FOOTNOTE

Here's a sentence with a footnote. [^1]

[^1]: It is the footnote.

Here's a sentence with a footnote. 1

-----------------------------------------------------

  • STRIKE THROUGH

Syntax:
~~Sentence~~

Example:
~~This sentence is incorrect~~

Output :

This sentence is incorrect

-----------------------------------------------------

Reference:

Github Markdown

Keep Learning !

Footnotes

  1. It is the footnote. ↩