How to write markdown files

This document is used, when you want to write the readme.md file. Uses the syntax from here.

Headings

- Largest to Smallest. Use `#` for higher and uses `######` for lowest.

The first largest heading tag with this `#`.

The second largest heading tag with this `##`.

The third largest heading tag with this `###`.

The third smallest heading tag with this `#####`.

The second smallest heading tag with this `#####`.

The first smallest heading tag with this `######`.

Bold with `**`

This text is bold.

Bold with `__`

This text is also bold.

Italic with `*`

This text is italic.

Italic with `_`

This text is also italic.

Strike Through `~~`

~~This text is Strikethrough.~~

Bold with Italic (Using both `** and _`)

Text is bold but this word is italic.

Whole text bold and italic with `***`

Whole text bold and italic.

Text with Quote `>`.

This is quote text.

Highlighted with "``"

This is a Backticks text.

Fenced Code Block

Use triple (```) - (fenced code block) for format the code on its own distinct block.

a = 5
b = 6
c = a + b

If you want to make the block as language specific. Please add the language identifier (name) after the fenced code block.

Example for python

def sample(*args) -> int:
    total: int = 0
    for element in args: total += element
    else: return total

Example for JavaScript

function your_name(name="Dummy") {
    return name;
};

let with_mention = your_name("Sample User");
console.log(with_mention);
let without_mention = your_name();
console.log(without_mention);

For adding a link. Use the following parameters:

- `[]` place the link text inside square braces.
- `()` place the URL inside round braces.

Example: Google Link [Google](https://www.google.com)

Google Link Google

For adding a image link, also showing image. Use the following parameters:

- `[]` place the link text inside square braces.
- `()` place the URL inside round braces.
- `!` add this symbol before the square braces.

Example: ![Dummy Image](https://source.unsplash.com/user/c_v_r/1900x800)

Dummy Image

video-tag

Foot Notes with ^

Sample 1[^1].
Sample 2[^2].
Sample 3[^3].
Sample 4[^4].

[^1]: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

[^2]: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

[^3]: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

[^4]: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

List

Unordered list with `-`

Item 1.
Item 2.
Item 3.
Item 4.
Item 5.

Unordered list with `*`

Item 1.
Item 2.
Item 3.
Item 4.
Item 5.

Ordered List

Item 1.
Item 2.
Item 3.
Item 4.
Item 5.

Nested List

Main Item 1.
- Nested Item 1.
- Nested Item 2.
- Nested Item 3.
Main Item 2.
- Nested Item 1.
- Nested Item 2.
- Nested Item 3.

Nested List Again

Main Item 1.
- Nested Item 1.
  - Nested Item 1.
  - Nested Item 1.
- Nested Item 2.
  - Nested Item 1.
  - Nested Item 1.
- Nested Item 3.
  - Nested Item 1.
  - Nested Item 1.

Task List

- Add empty square braces `[ ]` with space inside braces to make test pending.
- Add square braces `[X]` with `X` inside braces to make test complete.

[X] Done.
[ ] Pending.

Table

Column 1	Column 2	Column 3	Column 4
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.

Table with Text Align

- Left, using `:` colon, before `-` hyphen. Example `:---`
- Center, using `:` colon, both-side `-` hyphen. Example `:---:`
- Right, using `:` colon, after `-` hyphen. Example `---:`

Column 1	Column 2	Column 3	Column 4
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.
Something write here.	Nothing.	Hello, this is dummy.	This is nothing.
Nothing.	Something write here.	This is nothing.	Hello, this is dummy.

Collapsed Sections

- Using `<details></details>` Tag.
- Using `<summary></summary>` Tag for add click text.
- Using this you can use HTML code also.

Click for show python code

How to define function

    # Without Parameter
    def function_name():
        return

    # With Parameter
    def function_name(param_1, param_1):
        return

    # With Default Parameter
    def function_name(param_1, default_param=None):
        return

    # Asterisk
    def function_name(*args*):
        return

    # Double Asterisk (Dictionary)
    def function_name(**kwargs):
        return

How to define class

    class ClassName:
        # Class Attributes
        class_attribute_1 = None
        class_attribute_2 = None

        # Constructor
        def __init__(self):
            # Instance Attributes
            self.instance_attribute_1 = None
            self.instance_attribute_2 = None

        # Instance Method
        def instance_method(self):
            return

        # Class Method
        @classmethod
        def class_method(self):
            return

        # Static Method
        @staticmethod
        def static_method():
            return

How to write markdown files

Headings

The first largest heading tag with this #.

The second largest heading tag with this ##.

The third largest heading tag with this ###.

The third smallest heading tag with this #####.

The second smallest heading tag with this #####.

The first smallest heading tag with this ######.

Bold with **

Bold with __

Italic with *

Italic with _

Strike Through ~~

Bold with Italic (Using both ** and _)

Whole text bold and italic with ***

Text with Quote >.