⚡🔥 Better-Markdown

               

🚩 License

MIT License

⚡ What's New ?

v0.1 27/06/2023 - Added Basic Markdown Syntax

✌🏻 Contribute

1 Join The Discussion

2 Visit CONTRIBUTING.md

3 Create Issues

4 Create Pull Request

5 Star The Repository

📁 Content

1️ Heading

2️ Paragraph

3 Line Break

4️ Emphasis

5️ Backslash

6️ Blockquote

7️ List

8️ Task List

9️ Code Block

10 Horizontal Rule

11 Link

12 Indentation

13 HTML

✏️ Document Layout

In General, Most Documents Benefit From Some Variation Of The Following Layout :

# Document Title

Short Intro

## Topic

Some Content

## See also

Some Links

✏️ Heading

Prefer Using # Insted Of = Or - Underlines :

Heading  [ Level ? ]

---------

# Heading [ Level 1 ]

Prefer Spacing After # :

# Heading

Add Spacing

# Heading

Prefer Spacing Before And After The Heading :

Blank Line

# Heading

Blank Line

✏️ Paragraph

Don't Indent Paragraphs With Spaces Or Tabs :

This 1st Paragraph ...

This 2nd Paragraph ...

Prefer Using   To Indent Paragraphs :

  This Is 1st Paragraph ...

  This Is 2nd Paragraph ...  

✏️ Line Break

Don't Use \ To Line Break :

1st Line \

2nd Line \

Prefer Using <br> To Line Break :

1st Line <br>

2nd Line <br>

✏️ Emphasis

For Compatibility , Prefer Using ** Or <strong> To Bold The Words :

I Am ** Bold **

I Am <strong> Bold <strong>

For Compatibility , Prefer Using * Or <em> To Italicize The Words :

I Am * Italic *

I Am <em> Italic <em>

✏️ Backslash

Use \* Or \_ To Escape The Emphasis

\*I Am Surrounded By Literal Asterisks\*

\_I Am Surrounded By Literal Underscore\_

✏️ Blockquote

Prefer Spacing After > :

> Blockquote

Add Spacing

> Blockquote

Prefer Spacing Before And After The Blockquote :

Blank Line

> Blockquote

Blank Line

✏️ Lists

Don't Use Parenthesis As A Delimiter In Ordered List :

1. First Item

2. Second Item

Don't Mix And Match Delimiter In Unordered List :

- First Item

- Second Item

✏️ Task List

Prefer Spacing After - :

- [] Task

Add Spacing

- [] Task

✏️ Codeblock

Prefer Explicitly Declaring The Language Before The Codeblock :

```javascript

var a = 5;

console.log(a);

```

✏️ Horizontal Rule

For Compatibility , Prefer Using --- Insted Of *** :

1st Paragraph

---  [ --- ]

2nd Paragraph

Prefer Spacing Before And After The Horizontal Rule :

Blank Line

---  [ --- ]    

Blank Line

✏️ Link

Prefer Using %20 To Encode Any Space :

[Link](https://www.example.com/Hello%20!)

[ Special Character ]

Prefer Using %28 And %29 To Encode Parenthesis :

[Link](https://www.example.com/%28Hello!%29)

[ Special Character ]

✏️ Indentation

To Nest A Blockquote Add a >> In Front Of The Paragraph :

> First Blockquote

>> Nested Blockquote

> Second Blockquote

To Nest A List , Indent The Line With A Tab Or Four Space :

1. First Item

    - Nested Item

2. Second Item

To Create Code Blocks , Indent The Every Line With A Tab Or Four Space :

class Code{
 
     public static void main(){
        
         System.out.println("Hello World !");
         
     }
        
}

✏️ HTML

Prefer Spacing Before And After The HTML Tag :

Blank Line

<div> Hello World </div>

Blank Line

Don't Indent HTML Tag With Spaces Or Tabs :

Blank Line

<div> Hello World </div>

Blank Line