In this article I'll provide you a basic understanding of Markdown, it's usage and syntax.
What is markdown ?
Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents and they are save with a
.mdextension
Markdown is widely used by developers to create a nice documentation, user guides, notes and cheat sheets for their projects. Let's learn how to write it.
Paragraphs
Everything that is written in a markdown file is wrapped with in a paragraph by default. You can seperate the paragraphs a leaving a line between the.
Hello I am a paragraph having two lines
in my body with fourteen words.
I am another paragraph separated from above para.
Headings
We can create headings with hashes(#) followed by a space and heading. The more are hashes, the lesser font size
# Title Heading
## Sub Title
### Topics
#### Sub-Topics
Bold Text
We can make bold text by wrapping them with double asterisks **Here** or with double underscores __Here__.
I am making this text into **Bold** and __this one__ too
Italic Text
We can make text italic by wrapping them with single asteris *Here* or with single underscore _Here_
I am making this text into *Italic* and _this one_ too
Images
We can add Images to our markdown file to make the information more understandable
![Image]{https://www.example.com/your-image-link}
Links
We can add links in our markdown file to provide the users with required references such as a blog, documentation, git repo etc.
[Click Here](https://www.yourlink.com/your-link)
Ordered List
Ordered list gives information in an order with a numeric count as a prefix.
1. One
2. Two
3. Three
Unordered List
Text written with a hyphen as prefix will give unordered list -Text
- One
This is one
- Two
This is two
- Three
This is three
Writing Code
We can include code of any language wrapped with back-ticks.
`
Console.log("Hello World")
`
Blockquote
We can write some quotes or definitions or some important information as Blockquote so that the user will turn his eyes to it
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus augue sem, porta a sem non, imperdiet dignissim diam. Morbi imperdiet mollis augue ac congue.
That's it for Markdown guys. You can study more about markdown in detail from here. Have a great day!