Markdown Guide

date 16.11.2020

What is Markdown?

Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by **John Gruber** and **Aaron Swartz**.

It's basically helping us to create rich structured and lighweight text files without special software or editor. You can create your own markdown document with a notepad or any text editor. To create markdown file you have to give it **.md** extension.

Markdown Basics

Headings

We have 6 different headings in HTML. First one the biggest, last one is the smallest. We're using `#` to start using heading. To change it's level we can add more `#`. MarkdownDescriptionHTML equivalent`# Heading 1`Biggest heading`

Heading 1

``## Heading 2`2. heading and going smaller`

Heading 2

``### Heading 3 `3. heading`

Heading 3

``#### Heading 4`4. heading`

Heading 4

``##### Heading 5`5. heading`

Heading 5

``###### Heading 6`Smallest heading`

Heading 6

` *Please make sure you give enough space between # and the heading name.*

Paragraphs

Just type what you want to display as paragraph. MarkdownDescriptionHTML equivalent`Paragraph 🙂`Simple paragraph in markdown`

Paragraph 🙂

Bold

We can make some part of text **bold**. MarkdownHTML equivalent`Text with **bold** text``Text with bold text``Test with __bold__ text``Text with bold text` In HTML, you can also use `` for bold.

Italic

MarkdownHTML equivalent`Text with *italic* text``Text with italic text``Text with _italic_ text``Text with italic text` In HTML, you can also user `` for italic.

Blockquotes

MarkdownHTML equivalent`> Happiness depends upon ourselves.``

Happiness depends upon ourselves.

Lists

We can organize items using lists.

Ordered Lists

MarkdownHTML`1. First item``

First item

` I don't like this explanation so the next one will be better.

## Popular code editors

1. VsCode 2. Vim 3. Sublime Text 4. Atom

Unordered Lists

MarkdownHTML`- First item``

First item

``* First item``

First item

``+ First item``

First item

Images

We can display images with markdown. MarkdownHTML`image image url alt alt text```

Code

We can display code blocks with unique syntax highligting. MarkdownHTML```asm To define language you can add the language name after the first ```asm

```asm

echo "Hello World";