why open source matters

by dong

Why Learn Markdown If you have worked on any GitHub repo, you would have surely seen a README.md file, this is the markdown file where you can describe your repo. Markdown is easy to learn. It is helpful in writing questions on forums like StackOverflow, useful in commenting on Pull Request in Github, etc. It is a quick way to generated formatted text.

VS Code had inbuilt support for Markdown with the preview mode for generated HTML. VS Code md

Below is the markdown code that will generate HTML markup.

Basics of Markdown

Markdown is the most popular markup language that can be used to format documents. It can be used to create websites,ebooks,email,chats in discussions forums.

Topics

1. Paragraphs

   MD expects a full line space to show texts in a different line else it joins text in the same line. 2. Text decorations

   MD can write bold texts, ~~italiic~~ italic texts 3. Headings No of #’s represent the type of heading. Github will automatically add id’s to headings, so the text will be automatically linked.

   This is h2

   This is h3

   1. Links

My Github account.[Bhupendra][1] github repo.

1. Images Images can be used just like links.

   

   Thumbnails images can also be used which links to larger image

2. Ordered and Unordered Lists

   Coding Best Practices:

   • Keep code DRY
   • Writing Unit Test cases
   • Checking cross-browser support

   Steps to merge branch:

   1. Create a branch from feature
   2. commit your changes
   3. push your changes
   4. raise a pull request

3. Code Blocks

   This is super helpful when posting any code snippet

   js const fn = () => alert("some fn");

   css .hide { display:none }

   Also can show code difference

   diff var x = 10; - const counter = 0; + let counter = 0

4. Tables

   Tables can be generated with headings and text alignment option

   Stocks	Price
   TCS	230
   YES Bank	500

Cool Tips

• Grammarly extension can eliminate typo and grammar mistakes
• ScreenTOGif to record videos in GIF format
• Upload GIF’s to giphy to embed them into blog posts.
• Stackedit for Markdown Editing in Browser.

Below is the generated HTML from the markdown:

Basics of Markdown Markdown is the most popular markup language that can be used to format documents. It can be used to create websites,ebooks,email,discussions forums

Topics Paragraphs

MD expects a full line space to show texts in a different line else it joins text in the same line.

Text decorations

MD can write bold texts, italiic italic texts

Headings No of #’s represent the type of heading . Github will automatically add id’s to headings, so text will be automatically linked.

This is h2 This is h3 Links

My Github account.Bhupendra github repo.

Images Images can be used just like links.Alt txt

“cat Img”

Thumbnails images can also be used which links to larger image

Ordered and Unordered List

Coding Best Practices:

• Keep code DRY
• Writing Unit Test cases
• Checking cross-browser support

Steps to merge branch:

1. Create a branch from feature
2. commit your changes
3. push your changes
4. raise a pull request

Code Blocks

This is super helpful when posting any code snippet const fn = () => alert(“some fn”); css .hide { display:none }

Also can show code difference diff var x = 10; - const counter = 0; + let counter = 0

Tables

Tables can be generated with headings and text alignment option

Stocks Price TCS 230 YES Bank 500 Cool Tips

Grammarly extension can eliminate typo and grammar mistakes ScreenTOGif to record videos in GIF format Upload GIF’s to giphy to embed them into blog posts. Stackedit for Markdown Editing in Browser. heart2 unicorn 1 reading list 1 twitter logo DISCUSS dropdown menu icon bhupendra1011 profile bhupendra+ FOLLOW I am front end developer. I love exploring JS through IOT (Nodebots) , WebVR. Passionate about Web Performance and PWA’s

@bhupendra1011 twitter bhupendra1011 github bhupendra1011