A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about. While READMEs can be written in any text file format, the most common one that is used nowadays is Markdown. It allows you to add some lightweight formatting.
Some of the common syntax to make Markdown files attractive are:
Heading
For heading we use #. # represent heading1 (h1). The numbers of # used correspond to heading level. For example for heading6 (h6) ###### is used.
Paragraph
To create paragraphs, use a blank line to separate one or more lines of text.
Bold
To bold text, add two asterisks (**) or underscores(__) before and after a word or phrase.
Italic
To make text Italic, add one asterisk(*) or underscore(_) before and after a word or phrase.
Bold and Italic
To make text both Bold and Italic add three asterisk(***) or underscore(___) before and after a word or phrase.
Blockquotes
To create a blockquote, add a > in front of a paragraph.
Ordered Lists
To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one.
Unordered Lists
To create an unordered list, add dashes (-), asterisks (), or plus signs (+) in front of line items. -,,+ will be changed into bullets.
Code
To denote a word or phrase as code, enclose it in backticks (`).
URLs and Email Addresses
To quickly turn a URL or email address into a link, enclose it in angle(<>) brackets.
You can find all the syntax and information related to markdown at
https://daringfireball.net/projects/markdown
Top comments (0)