Markdown for Github
August, 2021
Intro
One of the most popular markup languages nowadays is markdown. Markdown is a lightweight markup language which is used to style plain text. It is easy to use and has various syntaxes for formatting text.
Markdown syntax applicable everywhere
Headers
# for h1
## for h2 and so on.
Emphasis
*Italics*
**Bold**
Unordered list
* item1
* item2
Ordered list
1. item1
1. item2
Image
Links
[name of website](url)
Blockquotes
> hey my name is aniket
Inline code
`const count = 10;`
Markdown syntax for github
Github has its own markdown syntax which gives an useful set of features to the users and makes their work easy.
Block of code
```
function alert(msg){
if(msg){
outputDiv.innerText = msg;
}}
```
Syntax highlighting
```javascript
function alert(msg){
if(msg){
outputDiv.innerText = msg;
}}
```
Tasklist
It is used in issues. Helps to breakdown the issue into small tasks.
- [ ] incomplete
- [x] complete
Reference to issue
Used to refer to issue or pull requests. It gets linked to the specific issue or pull request .
#64
Mentions
On mentioning a username, the user will be notified about the comment.
@username
Strikethrough
Whenever something is put inside double tildes, it gets crossed out.
~~striked~~
Advantages of markdown
- Markdown can be used to create documentation, websites, emails, etc..
- Markdown files are portable.
- It is platform independent.
- Lot of websites and applications support markdown.
- It is used to create documents which needs to be preserved for a long period of time.
- Fastest way to make notes or create documentation.