When we make a Repo on Github there are three options to initialize a repository with a file. One of them is add a README file. So what is that?
READMEs
A README file is used to communicate important information about a repository including:
- What the project does
- How to run the project
- Why it's noteworthy
- Who maintains the project
so READMEs plays important role, it's the first thing somebody looks at when they come to your project. title says all README ๐. this file is like any other file expect the its name very particular README.md so what is that md.
README.md
READMEs are Markdown files, ending with the .md extension. Markdown is a convenient syntax to generate formatted text. it generate Markups / Markdown it's easy to pick up !
Getting started with the elements of Markdown :
Headings:
# Thats Heading 1
## Thats Heading 2
### Thats Heading 3
#### Thats Heading 4
##### Thats Heading 5
###### Thats Heading 6
Preview:
Styling Texts:
Normal text like this ๐
**BOLD** OR __BOLD__ ๐
*Italic* OR __Italic __ ๐ผ
***That's Bold as well as Italicized Text***
OR
___That's Bold as well as Italicized Text___
~~Strikethrough~~
**That's Bold as well as _nested_ Italicized Text**
Preview:
Links:
For creating links we need two set of brackets, [Content] for writing the text for the link and (URL) for mentioning the URL within parenthesis.
[Welcome to Learn Code Online !](https://web.learncodeonline.in/)
Preview:
Welcome to Learn Code Online !
Images:
To insert an image to your Markdown file, add an exclamation mark (!) in the beginning followed by square brackets to add the image alt text inside that and finally add the URL or path to the image inside the parentheses.
Note : Make sure to not leave any space between the exclamation mark, square brackets and parentheses !
Preview:
Code Blocks:
To display any block of code, simply wrap the code block with Grave accent keys (`) thrice.
let firstName = "John";
console.log(firstName)
Preview:
Blockquotes:
## Blockquotes
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
Preview:
List:
Items can be organized into ordered and unordered lists.
1) Ordered Lists :
To create an ordered list, add line items with numbers followed by periods.
1. Ordered List 1
2. Ordered List 2
3. Ordered List 3
1. Ordered List 1
2. Ordered List 2
1. Indented item 1
2. Indented item 2
3. Ordered List 3
Preview:
2) Unordered Lists : For creating Unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Also Indentation of one or more items can create a nested list.
* Unordered List 1
* Unordered List 2
* Unordered List 3
- Unordered List 1
- Unordered List 2
- Indented item 1
- Indented item 2
- Unordered List 3
Preview:
Tables:
To create Tables, we can use three or more hyphens to create a header for each column (---), and separate those columns using pipes (|) and you can even use pipes on either ends of your table.
## Tables
| Country | Capital|
| ---------- | -------|
| Germany | Berlin |
| India | Delhi |
| Cuba | Havana |
Horizontal Rule:
For creating a horizontal rule, we can use three or more asterisks , dashes or underscores on a line.
******
OR
-----
OR
____________
Okay That's it I am Going Away Bye ๐๐ป ๐.