Markdown Tutorials

Aashish Chaubey
2 min readFeb 10, 2019

Recently, while I started building my GitHub profile, I came across GitHub Pages; static web pages for GitHub users, user blogs, project documentation, or even whole books. This is not only useful in GitHub Pages but often used in open source development and even at the enterprise level for the documentation of products and its resources.

Bold and Italics
- surround with _ to make it italic eg., _word_
- surround with ** to make it bold
- Put the marks in any order, it doesn’t matter which comes first and which one comes later

Headers
- Put as many numbers of # as you require eg., H1 -> #, H6 -> ######

Links
- For making a link, write the link text in the [] and then embed the link in () to make it look like a link. []()
- You can have formatting in the link you embed like bold, italics within the []
- There is something called the references which is another way to render the links in the markdown. In this you need to name the website and give it a reference, eg., [name][reference] and then at the end of the document attach the link to the reference like this [reference]: link.com. In this way you can reuse the link as many times as you want

Images
— Rendering of the images is the same as the rendering of the links in markdown
— It is just that the image link is to be prefaced with the ! mark
— The syntax is ![alt text](link.com), where alt text is not compulsory
— Since images are a link resource, you may not even want to render it in the same page, want to open in some other page. This is done by omitting the ! mark

Blockquotes
— Just adding a > symbol adds a blockquote to a line
— Give a line break to break out of the blockquote
— You can also have the other formatting within the blockquotes

Lists
— Place * to make it an unordered list
— Put 1. and so on to make it a ordered list
— You can also nest the list with just adding one extra space in front of the * for the item to be nested
— For adding texts for the items in the list, just leave one line and add a space indent to the text

Paragraphs
— Insert a new line in the paragraph to put the texts appear to be in the paragraph or else they will be contained in the same line or the better way is to add two spaces at the end of the line to make the remaining of the text appear in the new line.

--

--

Aashish Chaubey

Data Science and Machine Learning enthusiast || Passionate Computer Science Engineer || Love Analyzing || https://aashishchaubey.com