Markdown Language

Yashod Perera
3 min readApr 3, 2020

--

What is Markdown Language?

It is a way of formatting text. the usefulness of the markdown language is it is portable, it ie use everywhere, platform independent and many more.

Okay Let’s start to learn the syntaxes.

Following is the sample markdown document and the preview of the document.

Markdown Document
Preview

Headings

There are 6 types of heading are available on markdown language and they can be produced using # mark as follows.

The left side shows the syntax and the right side shows the preview

Bold and Italic styling on text

Using markup language we can highlight words using either bold or italic and it is so simple to use using “_” or “*” symbols as in the following example. You can use this styles for any text, heading or links.

The left side shows the syntax and the right side shows the preview

Lists

Numbered lists and bullet lists can be included in documents using markup language and the syntax is simple. For the Numbered lists you have to add the number and a dot and for the bullet lists have to add a dash mark(-) and a space as in the following example.

The left side shows the syntax and the right side shows the preview

Coding examples

The coding pieces can be included in to the document using special syntaxes for single line and multiline comments as follows.

The left side shows the syntax and the right side shows the preview

Quotes

The special quotation can be added to the document using the “>” symbol.

The left side shows the syntax and the right side shows the preview

Tables

To add tables first you have to add the table head dividing columns using “|” symbols and after that you have to add | — — — | to indicate per column to indicate that as a table. Following example is more clear.

The left side shows the syntax and the right side shows the preview

Links

To indicate links there are three ways to do it in markdown language.

  • Add immediately after the link name
[Link name](link address)
  • Add in a different place using the link name
[Link name][//]: #
[Link name]: <link address>
  • Add in a different place using a reference name
[Link name][reference name][//]: #
[reference name]: <link address>

Following is an example for all three above methods.

The left side shows the syntax and the right side shows the preview

With above example basics of the markdown language is covered. Hopefully this is helpful.

If you have found this helpful please hit that 👏 and share it on social media :)

--

--

Yashod Perera
Yashod Perera

Written by Yashod Perera

Technical Writer | Tech Enthusiast | Open source contributor

No responses yet