Markdown Syntax

2022-10-20 CC BY-NC 4.0 687 words 4 minutes

Contents

This article shows some useful and daily-driver type syntax, that I may use daily. First, right after heading, one example , followed by it’s syntax. I won’t explain though 😅.

Note

To learn in detail and easily, you may use following references,

and of course, there is GitHub wiki. I don’t think I need to mention this. 😅

Text formatting

List

1
2


* text
* text

text
text

1
2
3
4
5


    + text
    - text
      - text
      - text
    + text

text

text
- text
- text

text

Note

(Above code) +/- doesn’t matter here!

For numbered list, it’s not this much easy, you’ve to manually write 1, 2, 3 like this one,

hello
welcome to my
website

Emphasis

1
2


***emphasis***
___emphasis___

emphasis

Bold

1
2


**bold**
__bold__

bold

Italic

1
2


*italic*
_italic_

italic

Strikethrough

1

~~strike~~

~~strike~~

Heading

1
2
3
4
5
6


# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading

Horizontal lines

1
2
3


---
___
***

Blockquotes

1
2
3
4
5
6


> hello
> this is a Blockquote
>> this is a nested
Blockquote

> Got it?

hello this is a Blockquote

this is a nested Blockquote

Got it?

Task List

1
2


- [ ] this task is incomplete
- [x] this task is completed

this task is incomplete
this task is completed

Inline Code

1

`code can be in any language` along with text

code can be in any language along with text

Indented Code

Indented= putting some lines before a line, used in programming, right? Here we’ve to use at least 4 space 🧐, though I don’t know the reason 😄.

1
2
3
4
5


    <pre>
      Yo! This is a test to write
      forward slash = /
      backward slash = \
    </pre>

<pre>
  Yo! This is a test to write
  forward slash = /
  backward slash = \
</pre>

Block Fenced Code

1
2
3
4
5
6
7
8


    ``` cpp
    #include <iostream>
    int main ()
    {
        std::cout << "Hello world! \nHow cool is that?";
        return 0;
    }
    ```

1
2
3
4
5
6


#include <iostream>
int main ()
{
    std::cout << "Hello world! \nHow cool is that?";
    return 0;
}

Note

Fun Fact ⛱️

I used cpp after first ``` to enable syntax highlighting for c++. Same can be used for javascript (js), markdown (md) or any other languages.

Table

1
2
3
4
5


|Left align|Center align|Right align|
| :--- | :---: | ---: |
|Fist column, First row|Second column, First row|Third column, First row|
|First column, Second row|Second column, Second row|Third column, Second row|
|First column, Third row|Second column, Third row|Third column, Third row|

Left align	Center align	Right align
Fist column, First row	Second column, First row	Third column, First row
First column, Second row	Second column, Second row	Third column, Second row
First column, Third row	Second column, Third row	Third column, Third row

Note

Table without alignment (without using :, just ---) will center align the first row. Second onwards will be using left align!

Links and ancors

1
2
3


<https://t.me/SharafatKarim>
[My telegram](https://t.me/SharafatKarim)
[My telegram account](https://t.me/SharafatKarim "My telegram profile")

https://t.me/SharafatKarim

My telegram

My telegram account (Hover over it - desktop PC)

1
2
3


***Table of Contents***
* [Comment Section](#comments-syntax)
* [Inline Code](#inline-code)

Table of Contents

Comment Section
Inline Code

Footnotes

1
2
3
4
5


This is a footnote [^1]
This is an another footnote with label [^label]

[^1]: This is the note for first footnote
[^label]: This is the note for the second one

This is a footnote ¹

This is an another footnote with label ²

Images 🔮

1

![An octodex image - Fintechtocat](https://octodex.github.com/images/Fintechtocat.png "An octodex image")

Comments Syntax

1

<!-- This is a comment! -->

Contents

Markdown Syntax

Text formatting

List

Emphasis

Bold

Italic

Strikethrough

Heading

Horizontal lines

Blockquotes

Task List

Inline Code

Indented Code

Block Fenced Code

Table

Links and ancors

Table of contents

Footnotes

Images 🔮

Comments Syntax