README : Creating a Readable Markdown README File
Before moving into writing a Readable Markdown README, we will initially focus on the markdown sytax first (Step 1). In Step 1 we will learn how to make the full use of the markdown language to its fullest potential.
And then in the Step 2 , we will create an awesome README File.
Step 1 : Markdown 101
Markdown is a light markup languge used to mark the text formatting slightly up a notch. Its usages range from GIT to language specific markdowns such as R and has numerous flavors.
In our case we will be particularly looking at the GIT flavored Markdown formatting.
Title : #. Number of hash indicates which heading tag i.e
#This is h1
##This is h2
###This is h3.
Bold : Double Asterisks
The bigger the mountain, the better the view
become : The bigger the mountain, the better the view
Italic : Surround with Underscores (Occasionally * may work)
“It had long since come to my attention that people of accomplishment rarely sat back and let things happen to them. They went out and happened to things.” – Leonardo da Vinci
“It had long since come to my attention that people of accomplishment rarely sat back and let things happen to them. They went out and happened to things.” Leonardo da Vinci
Code : Surround in back-ticks
print(" To Code the document, or not to? ")
Link : Wrap text link in square-brackets with link in round brackets
Click here to visit Google.
Lists : use – or *
Step 2: Coming soon
Happy Documenting. Have a Great Day. 🙂