Skip to content

Latest commit

 

History

History
160 lines (143 loc) · 3.56 KB

General_markdown.md

File metadata and controls

160 lines (143 loc) · 3.56 KB
Raw

Headings

<h1> = #
<h2> = ##
<h3> = ###
<h4> = ####
<h5> = #####
<h6> = ######

H1

H2

H3

H4

H5
H6

Next line

In order to move to next line leave 2 additional space after the end of line

like this

Bold

Bold using two ** before and after a specific word
Bold using two __ before and after a specific word

Italics

Italicise using single * before and after a specific word
Italicise using single _ before and after a specific word

Striking words

Lets say you have written something like this and in the process a new feature has been added and you need other users to notice it without even comparing with previous version then visually we can represent it using these (~~)

 ~~symbols~~ **Mark Down Syntax**

List

  1. Ordered
  • Unordered
    To add ordered and unordered list use 1. and *
    Lets say you have to add
    Table of Contents
  1. Title
  2. Introduction
  3. Architecture
    1. Micro Services
    2. Serverless Computing
  4. Conclusion
    To write beautiful contents table like this follow the syntax
1. Title
2. Introduction
3. Architecture
    1. Micro Services
    2. Serverless computing
4. Conclusion

Links & Images

Links are useful when you need to write blogs or when you need to redirect users to other topics

[title here](link here)

Let's assume you need to add social media links to make it more visual

[![Title](link of the image)](redirecting link to your profile)

For image use

![Title of the image](link to the image "to label the image use double quotes immediately after the link")

Tables

Example

one two three
row1 value2 value3

well you can use this for pretty much anything

  1. Display table
  2. Display images
  3. Todo list and status
  4. Project status
    It`s left to your immagination
|one |two |three |
|--- |--- |--- |
|row1 |value2 |value3 |

You can use html table also

Horizontal Rule

using ___ three underscore

using *** three stars

TODO List

[x] done
[ ] in list

[x] to indicate its done  
[ ] to indicate still pending

Scripts

to diclare variables var

use single back ticks to make it look like its a variable `name of the variable`

Code block

So all this time you might be wondering how to include code blocks, we can do it two ways:

  1. > this is single line
  2. ``` for multiple lines

Single line

in oreder to put script related to installation procigure or command line like the line below use

> npm install
> or use to specify quotes

Script block

\```language
specify language for syntax highliting
for python just use ```python  \''' incluse these at the end to close the section

Emojis

You can even include emojis like these in the markdown :hugs: :grinning: :smiley:

Emojis can be used by surrounding a valid emoji name with colons( : ) like this :emoji-name: For example, :smiley:

Follow the link below to know more

Socila Link

Badges