Make a README.md file

Contents

The undoubtedly most popular repository provider; GitHub(also Gitlab and that Bitbucket) uses a file README.md as the repository descriptor. Making the README file good attracts people to use your repository. In this page, I will try to explain you how to make a README file.

I am using an online code editor, you can use VS Code or any other code editor too.

Headings

Headings are commonly used, used everywhere. In a README.md file, you can identify a heading with #(Hashtag). If we put 1-7 #(Hashtag)s, then the file executes a heading.


				# Heading
				## Heading 2
				### Heading 3
				#### Heading 4
				##### Heading 5
				###### Heading 6
				####### Heading 7

Write a normal text

You need not to write any code for viewing a normal text. Just WRITE it!

For example: I am a great boy

Italics

For writing in Italics, you need to provide a _(Underscore) at the starting and end of the text.

Example: _Are the people living in Italy called Italics?_

Bold text

For writing a bold text, you should put two **(Asterisk) at the beginning and ending of the text.

For example: **Hi guys, and welcome to this GitHub page.**

Strikethrough

For striking through a text, you have to put two ~(Tilde)

Hyperlinks

Hyperlinks are used to connect the WebPage with any other page or a portion of the same WebPage. To insert a hyperlink in README.md, all you have to do is to write the code in this format: [Text to display](target URL "title")

For Example: [Open Facebook](https://www.facebook.com "Facebook")

Image

To insert an image into a README.md file, you have to write the code in this format: ![image name](target URL)

Table

To insert a table in a README.md file, you have to write the code in this format:


			|Heading 1|Heading 2|
			|---------|---------|
			|Content 1|Content 2|

Lists

To insert a list in README.md, you have to write the code in this format:


				1. Main component
				2. Main component 2
				 * Sub component
				 * Sub component 2

Quote

To insert a quote in README.md file, you have to type the >(Right-angled bracket) at the beginning of the text

For example: > This is a quote

Code

To insert a code in README.md file, you have to insert a ` both and the beginning and end of the text.

For example: `console.log('Bruh')` prints 'Bruh' in the console of the Browser.

Code Block

To insert a code block in a README file, you have to type triple ` at the beginning as well as the ending of the text.

Note: You can also define the language of your code by typing the name of the language just after the first three `s

For example:


				```Python
				if firstName = 'newton':
				 print('Have an apple')
				```

Horizontal line

To insert a horizontal line in README.md file, you have to write the code in this format:


				Three asterisks(*) execute a dark horizontal line
				***
				Three hyphens(-) execute a light horizontal line
				---