I had set up the content management of this website using Markdown for its convenience. It is a lightweight markup language for creating formatted text using a plain text editor.

Its great especially for: Documentation, Creating websites, Project ReadMe files, GitHub Issues, GitHub Pull Requests, comments, among other things. One of the cool features of Markdown is that it can be used inside html blocks and html tags (excluding some) within a Markdown file.

If you're already familiar with Markdown, this article will serve as a refresher as well as a quick start guide for beginners.

Heading

Just like HTML, Markdown heading can be written up to H6

Markdown:

Heading 1         # H1
Heading 2        ## H2
Heading 3       ### H3
...             ...
Heading 6    ###### H6

Font Emphasis

Fonts can be italicized, bold with asterisk (*)

Markdown:

Italic          *Italicized Text*
Bold            **Bold Text**

Lists

Two types of lists can be created: Unordered List (Bulleted Points) and Ordered List (Numbered Points).

Markdown:

Ordered List            1. First Item
                        1. Second Item
                        1. Third Item

Preview:

  1. First Item
  2. Second Item
  3. Third Item
N.B.: As you can see, I didn't go for conventional way of writing ordered list (1., 2., 3., and so on). However, the Markdown previews the list in a numbered list. This is a simple trick, say if you need to rearrange any order you can simply cut it and paste it anywhere in the list, the Markdown will automatically rearrange the order.

Table

Tables can be easily created in Markdown files, and the content of a cell can easily be aligned to left, center, or right as shown in the example.

Preview:

Heading 1 Heading 2 Heading 3
col 1 is left-aligned $10000
col 2 is centered $12000
col 3 is right-aligned $15000

Code

Codes can be added as an inline code, and as a block of code as below.

Preview:

example of inline code

string str = "Hello World";
cout << str;
N.B.: The name of the programming language is optional. If added, the syntax will be highlighted according to the language.

Links & Images

Links and images are quite similar syntax-wise.

Markdown:

Link            [A Soft Murmur](https://asoftmurmur.com/)

Image           ![An Apple](/assets/img/example.png "an apple")

Preview:

Link: A Soft Murmur

Quotes

Quotes can be written with a ">" sign.

This is an example quote

Highlight

Another interesting stuff about Markdown is to highlight a sentence or portion of a sentence.

This word is highlighted

Here are some resources that are super helpful in getting started with Markdown: