Markdown Cheat Sheet
A Guide to understand the basic of Markdown
Overview
This cheat sheet will help any new user to understand the basic syntax and quick overview of Markdown. In this article, you'll learn what markdown is and how to use it.
What is Markdown?
Markdown is a lightweight markup language like HTML, for creating formatted text. To start with markdown you need to simply save your text file with .md
extension and then you can use markdown syntax to write content using editor like Visual Studio Code, Atom, Sublime Text, Notepad, Notepad++, which support markdown. A good example would be a blog post or a git README file, even you know what hashnode also support Markdown for writing article and blogs.
So keep clam and let's start learning more about Markdown.
Basic Syntax
Below I'm listing down the basic syntax of Markdown which will make easy to understand how to use them.
Element | Syntax | Output |
---|---|---|
Header | # header 1 ## header 2 ### header 3 #### header 4 |
header 1header 2header 3header 4 |
Bold | ** Bold ** OR __ Bold__ |
Bold |
Italic | * Italic * OR _Italic_ |
Italic |
Strikethrough | ~~ Strikethrough ~~ |
|
Blockquote |
> Blockquote |
Blockquote |
Unordered List |
- item1 - item2 |
|
Ordered List |
1. item1 2. item2 |
|
Code |
` print("Hello Markdown!") `
|
print("Hello Markdown!")
|
Horizontal Rule |
--- |
|
Link |
[Link](markdownguide.org/basic-syntax/#links) |
Link |
Image |
![alt text](learncodeonline.in/mascot.png) |
|
Task List |
- [x] Write the press release - [ ] Update the website - [ ] Contact the media |
|
Highlight | This is all you need to do to get ==highlighted text== |
This is all you need to do to get highlighted text |
Emoji | That is so funny! :joy: |
That is so funny! 😂 |
Subscript | H~2~O |
H 2 O |
Superscript | X^2 |
X2 |
Conclusion
Thanks a lot for reading and hope now you know how to create an awesome README for your next project. For more information please checkout the official MarkDown Guide site. And don't forget to hit a 👍 if you find this article helpful. Happy learning! 🎉