What is markdown?
Markdown is a plain text formatting syntax aimed at making writing for the internet easier. The philosophy behind Markdown is that plain text documents should be readable without tags mussing everything up, but there should still be ways to add text modifiers like lists, bold, italics, etc. It is an alternative to WYSIWYG (what you see is what you get) editors, which use rich text that later gets converted to proper HTML.
CUT THE CRAP
Markdown is an easy way to format your text and is used in a lot of places, Github, blogging sites, Emails, To-do list etc.
Let's Learn Some Basic Syntax
Headings ( # )
- h1 -> #
- h2 -> ##
- .
- h6 -> ######
# The largest heading ## The second largest heading ###### The smallest heading
The largest heading
The second largest heading
The smallest heading
Styling Text
Italics ( * or _ )
Hello * i am italic * ; Hey _ i am italic too _
Hello i am italic ; Hey i am italic too
Bold ( ** or __ )
Hello ** i am bold ** ; Hey __ i am bold too __
Hello i am bold ; Hey i am bold too
Quoting Text ( > )
> This is a quote
This is a quote
Embedd Code ( ``` )
```
function quote() {
console.log("this is how you embedd a piece of code");
}
```
function quote() { console.log("this is how you embedd a piece of code"); }
Lists
Number List
1. item one 2. item two 3. item three
- item one
- item two
- item three
Bullet Points ( * , - )
* first point * second point - third point - fourth point
- first point
- second point
- third point
- fourth point
Embed Images
![ image caption ](https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/1200px-Markdown-mark.svg.png)
Embed Video
[![Watch the video](https://img.youtube.com/vi/T-D1KVIuvjA/maxresdefault.jpg)](https://youtu.be/T-D1KVIuvjA)
Embed Links
github.com - GitHubgithub.com - [GitHub](http://github.com)
Table
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |
First header | Second header
-------------|----------------
cell 1 | cell 2
first column | second column
First header | Second header |
cell 1 | cell 2 |
first column | second column |
Task List ( works in github )
TASKS: - [x] Write a blog on markdown - [ ] Write another blog
- [x] write a blog on markdown
- [ ] write another blog
This platform dosen't support the above. But it will work on github.
You have learnt all the basic syntax of markdown. Try using it in your github project's README.md
file.
Reference github docs