Myronic / MARKDOWN-CHEATSHEET

A complete cheatsheet with examples for all basic syntax used in a README.md file.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MARKDOWN-CHEATSHEET ๐Ÿ“

A complete cheatsheet with examples, well commented, for all basic syntax used in a README.md file ๐Ÿ˜Š

image:

MD


headings:

Inspriation can take you

from A to B, but imagination

can take you from A

to whatever

you want
to Be!

bold, italic, strikethrough:

this text is italic
this text is also italic
this text is bold
this text is also bold
this text is strikethrough


linebreak:

para1 para2
vs
para1
para2


escape characters:

use \ to escape characters like *t&c*


blockquote:

this is a blockquote


links:

my insta link: @MYRONIC


unordered lists:

  • item 1
  • item 2
    • 2.1
    • 2.2
      • 2.2.1
        • bas na ab.

ordered lists:

  1. item1
  2. item2
    • random...

inline codeblock:

<p>this is a para tag </p>
void main(){ printf("single line code"); }


block of code:

JavaScript:

var mylink = "https://github.com/Myronic";
function (mylink){
     console.log(mylink);
     }

C:

void main(){
    printf("Hello Github");
}

Python:

def add(num1, num2):
    return num1 + num2

so on for all languages...


Tables:

name email
Myron myron.c@somaiya.edu

checklist:

  • Learn
  • something
  • new
  • everyday! that's it!

bash: (for beginners like me :D )

Say you want to

  • fork this repo (your own copy of this repo)
  • clone as local repo to pc
  • make changes
  • push those changes back to remote(github)
  • and send a pull req to main repo(this repo)

First, fork this repo.
next, run these commands in terminal (make sure git is installed. to check: git --version)

git clone https://github.com/YOUR-USERNAME/MARKDOWN-CHEATSHEET

cd MARKDOWN-CHEATSHEET

git init master

git remote add origin https://github.com/YOUR-USERNAME/MARKDOWN-CHEATSHEET

git remote add upstream https://github.com/Myronic/MARKDOWN-CHEATSHEET

<---make the desired changes--->

git add .

git commit -m "add a commit message here"

git push origin master

all changes thus made in local repo (your repo on pc) is now reflected in your remote repo(your repo on github), now you can send a pr via github to main repo (this repo from where you forked). Later on, incase you need to sync your local/remote repo with the main repo use the following commands:

git fetch upstream 

git merge upstream/master

git push origin master
For quick brush of what all just happened here watch this video by Brad Traversy :Markdown crash course

For all emojis : Click here

-myronic ๐Ÿ˜‰

About

A complete cheatsheet with examples for all basic syntax used in a README.md file.