loading...
Cover image for How to write blog posts [Markdown]

How to write blog posts [Markdown]

bhupendra1011 profile image bhupendra ・3 min read

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
4. Links

   [My Github](https://github.com/bhupendra1011 "all repos") account.[Bhupendra][1] github repo.

5. Images
    Images can be used just like links. ![Alt txt](img url)

    !["cat Img"](http://placekitten.com/200/200)

    Thumbnails images can also be used which links to larger image 
    [<img src="http://placekitten.com/20/20">](http://placekitten.com/200/200)

6. 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
    1. commit your changes
    1. push your changes
    1. raise a pull request

7. 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
    ```



8. Tables 

    Tables can be generated with headings and text alignment option

    |Stocks|Price|
    |:-----:|------:|
    |TCS|230|
    |YES Bank|500|



Cool Tips 

 * [Grammarly](https://marketplace.visualstudio.com/items?itemName=znck.grammarly) extension can eliminate typo and grammar mistakes
 * [ScreenTOGif](https://www.screentogif.com/) to record videos in GIF format
 * Upload GIF's to [giphy](https://giphy.com/) to embed them into blog posts.
 * [Stackedit](https://stackedit.io/) 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

  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 text will be automatically linked.

    This is h2

    This is h3

  4. Links

My Github account.Bhupendra github repo.

  1. Images
    Images can be used just like links. Alt txt

    "cat Img"

    Thumbnails images can also be used which links to larger image

  2. 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
1. commit your changes
1. push your changes
1. raise a pull request
  1. 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
```
  1. 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.

Discussion

pic
Editor guide
Collapse
pliski_ profile image
Pliski

Nice post, but I think I missed the "How to write blog posts" part.