In this article, you will learn to write a basic markdown file, most of the times you can find a readme.md file which contains basic information of the files in the repository. Markdown is a scripting language used to format plain text to a respective design. Popular repository providers like Github and bitbucket use readme.md for providing description about the repository.
I am going to explain about the syntax of the markdown so that you will have a better understanding of the markdown script
Headings
For writing headings, you need to add # symbol at the beginning of the text. As the number of hash symbols increase heading gets smaller.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Output:
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Hyperlinks
You can add a hyperlink using by using the below example.
[link name](targetURL)
e.g [Google](https://www.google.com)
Output:
Strong and italic text
You can write bold and italic text using underscores and asterisks before and after the text.
_Italic text_
**Strong text**
Output:
Italic text
Strong text
Images
You can add images in a markdown by using the below example.
![imagename](targetURL)
Output:
Table
You can write a table by using the below example.
|Course|Instructor|Platform|
|-------|----------|---------|
|FSJS|Hitesh|iNeuron
Output:
Course | Instructor | Platform |
FSJS | Hitesh | iNeuron |
Code
You can write a block of code by adding ``` at start and end of the code.
```
function fun(){
return 10;
```
Output:
function fun(){
return 10;
Lists
You can write an unordered list, ordered list using below example
* Unordered list
* Unordered item
* Unordered item
Ordered list:
1. Ordered item
2. Ordered item
3. Ordered item
Output:
- Unordered list
- Unordered item
- Unordered item
Ordered list:
- Ordered item
- Ordered item
- Ordered item
Thank you for reading!
#CSS #Markdown #LCO #IWriteCode #iNeuron #FullStackJavaScriptWebDeveloperBootcamp