A basic introduction to Markdown


A basic introduction to Markdown

Being an old school fella, in most of my dealing with code-versioning systems(Clearcase, SVN and  CVS), 
I used to keep references of what each folder did by thinking  of good-old names of what each folder and file within did. Sometimes  in order for me to take care of boiler-plates or other known issues or  improvements, I would go ahead and maintain a README.txt.

Starting a few months ago, my interactions with git and git based code started increasing a lot, and over there I started looking at  README's with an extension of .md, this piqued my interest a few  weeks ago and I started reading up more on this and this blogpost is  the culmination of what I've understood

md an introduction

md stands for markdown which is a lightweight markup language that contains formatting all done via plain text. And when hosted in git, appears  in a convienient html format which is easy to read. (I now understand how the details of the project appear in formatted html as soon as I scroll down)

More about a md (basic)

Md can easily display headers, italic words, bold, well the list goes on.... and on.
Md takes the first preference to generate the git's html summary over other extensions.
So what can I do to style (a.k.a cheat sheet)
Heading:         This line is a heading
======================
Sub heading:         This line is a sub-heading
--------------------------
Headings: # H1
## H2
### H3
#### H4
##### H5
###### H6
Paragraphs: Blank line or enter key
Line breaks:           followed by enter key
Blockquote:  > This line is a blockquote
 >> This line is a nested blockquote
Italic text:          *This line is written italized*
Bold text:  **This line is going to be bold*
Both of the above:          **asterisks and _underscores_**
Strikethroughs: ~~This feature is no longer present.~~
Unordered list: - Unordered sub-list-item1.
- Unordered sub-list-item2.
+ Unordered sub-list-item3.
* Unordered sub-list-item4.
- Indented item#1
- Indented item#2
Ordered lists:         1. Ordered sub-list1
2. Ordered sub-list2 (you actually dont need to do a 2, but let it be)
1. Indented item#1
2. Indented item#2
Blocks of code: Four spaces or one tabspan
Eight spaces or two tabspan when you want code in a list item
Images: ![Star wars Yoda](/assets/images/yoda.png)
Hyperlinks: [Star wars Yoda](https://en.wikipedia.org/wiki/Yoda)
Email id':          
Emphasize: **[Star wars Yoda](https://en.wikipedia.org/wiki/Yoda )**
To learn more about the extended syntax check this link out Extended Syntax
Here are the references that I referred to while typing this out

Comments

Post a Comment

Popular posts from this blog

DumbCharades (DC) and its different rounds or concepts

Dumb-charades... or DC or Dumbsi is a wonderful game, and can be called full time pass or in other slang paisa vasool .... This is the game I play whenever I have to either go to or come back from my workplace, and I must say the bug has caught on. Slowly but surely there have been a steady addition to the number of people who play the game. Moreover we had a neat trip to Kerala the whole team of us and all through the while we were at it... from struggling first timers to seasoned pro's (read me) we played this game and it gave us a whole lot of fun. Some of the different concepts or rounds that can be used to play DC are listed below, do feel free to add your concept to this :D Name of Movies Name of Television Serials Name of Famous personalities Incidents of Historical significance Name of Hotel's (can be location specific) English words (help in enhancing your vocabulary) Songs (has different variants, can be the Ending letter to continue, can be a word picked from the...
Read more

Gaalipata .... Hype ???? Hope Not !!!

Image
Today marks the day Mungaaru Male Part II or rather the next movie that has the Yograj Bhat - Ganesh combination part II is released. There has been a lot of eager anticipation and tongue in cheekiness regarding the movie. Will it prove to be a hit or will it die down in a whimper ? This my friends is left to be seen. I hope it is not a hype and will prove to be another bumper in terms of records, I hope for this to happen not only to keep Ganesh's and Yograj Bhat's reputation intact but, also for the careers of the following people I adore. Rajesh Krishnan the singer par excellence, AIR Karnataka's singer of the year, now who has lost out on various singing chances due to the entry of so many Hindi singers. Neethu from Poojari to Gaalipata , hope this movie makes it great for this talented actress- danseuse Diganth is on a roll now a days, Daisy Bopanna , this leggy lass is my lambi race ki ghodi ...watch out she is good. The songs of the movie have come ou...
Read more

Idhu Mussanje Maathalla Mussanje GoLu

Image
Kiccha Sudeep in a new avtaar, and I went along to watch his latest offerring Mussanje Maathu, due to wifey's persistence of going to the theater and watching him. After the 1st reel of this film the laughter all but died away, then started my GoLu (for those who are learning kannada it means An evening of sorrow). Thankfully it was just Rs 40 per ticket, would have definately cried if I had watched it in a Multiplex. The story goes like this Sudeep is this Agony Uncle on Radio Mirchi Sakkath Hot maga and runs a daily evening Radio Show, where in people from different walks of life dial in and share their cuppa sorrows. Mr elegant personified Sudeep lends then a supporting shoulder (thru air waves) and suggests a few words of pearly wisdom. This man who provides people with a Ray of Hope suddenly finds that he has fallen head over heels in love, but does not express his feelings to the girl (Ramya). He helps in uniting her with her estrangled dad, and is devastated when she is enga...
Read more