๐ Learn Markdown In Minutes ๐
โช Using the markdown syntax, this blog will show you how to create your own readme file for your GitHub projects. โฉ
What is Markdown?
A plain text formatting syntax called Markdown was created with the goal of simplifying internet writing. The idea behind Markdown is that while there should be a method to add text modifiers like lists, bold, italics, etc., plain text documents should still be readable without tags cluttering up everything.
To learn more, Go Here
All about README file :
A README file is crucial because it provides other developers and contributors with a thorough summary of your GitHub project.
Why would I spend the effort developing a README file must be a question that some people have. Well, I'll offer you a few reasons why it won't be a waste of time.
A strong README makes your project stand out from the competition, thus it must be just as strong as your project itself.
Any project's README file is the first thing that users notice, so it should be brief, visually appealing, and of course well-explained.
Therefore, it is evident from the foregoing reasons why you should have a single README file that is both useful and appealing.One of the few things you can focus on to improve your chances of attracting the attention of other developers is that.
Starting with Markdown's building blocks:
1. Headings :
# That's Heading 1
## That's Heading 2
### That's Heading 3
#### That's Heading 4
##### That's Heading 5
###### That's Heading 6
๐ Preview :
2. Styling Texts :
๐ Preview :
3. Paragraphs :
There is a blank line between each paragraph to separate them.
This is the first paragraph
This is the second paragraph
๐ Preview :
4. Links :
Two sets of brackets are required when creating links: [Content] for the link's text and (URL) for the URL to be mentioned within parenthesis.
[Welcome to LearnCodeOnline !](https://web.learncodeonline.in/)
๐ Preview :
5. Images :
Add an exclamation point (!) at the beginning of your Markdown file, followed by square brackets for the picture alt text, and then add the URL or path of the image inside the parentheses.
Keep in mind: Be sure there is no gap between the exclamation point, square brackets, and parenthesis!
![image](https://lco.dev/images/logo-white.png)
๐ Preview :
6. Code Blocks :
Simply enclose any code block with the Grave accent keys (') three times to display it.
a = 10
print(5 < a < 15)
print(7 == a < 3)
๐ Preview :
Reminder: After pressing the top triple grave accent key, add the language name to enable syntax highlighting in code blocks.
a = 10
print(5 < a < 15)
print(7 == a < 3)
๐ Preview :
7. Blockquotes :
You can insert > in front of a paragraph to make blockquotes.
Learn markdown syntax `to create` beautiful readme files
๐ Preview :
8. Nested Blockquotes :
Nested blockquotes are another option. Just place >> before the paragraph you want to nest.
> Create attractive readme files by learning markdown syntax.
>
>> Improve projects by adding a quality readme file to attract the attention of other developers.
๐ Preview :
9. Lists :
Both ordered and unordered lists can contain items.
Ordered Lists :
Add line items with numbers followed by periods to form an ordered list.
1. Ordered List 1
2. Ordered List 2
3. Ordered List 3
๐ Preview :
1. Ordered List 1
2. Ordered List 2
1. Indented item 1
2. Indented item 2
3. Ordered List 3
๐ Preview :
Unordered Lists :
Add dashes (-), asterisks (*), or plus signs (+) in front of line items to create an unordered list. Additionally, a nested list can be created by indenting one or more elements.
* Unordered List 1
* Unordered List 2
* Unordered List 3
๐ Preview :
- Unordered List 1
- Unordered List 2
- Indented item 1
- Indented item 2
- Unordered List 3
๐ Preview :
10. Tables :
To make tables, we can use pipes to divide the columns (|), three or more hyphens to form a heading for each column (---), and pipes on either end of the table.
| Country | Capital|
| ---------- | -------|
| Germany | Berlin |
| Qatar | Doha |
| Cuba | Havana |
๐ Preview :
11. Horizontal Rule :
We can use three or more asterisks, dashes, or underscores on a line to create a horizontal rule.
******
OR
-----
OR
____________
๐ Preview :
12. Escape Characters : :
If you want to use a character that has a special significance in the Markdown syntax, you must escape it by using the backslash character.
๐ Preview :
13. Line break :
After the line ends, we can use a backslash to indicate a line break, and then we can continue writing on the next line.
Hello\
World
๐ Preview :
# Cheers!๐โจ๐๐ - End of Note You have succeeded. What are you waiting for now that you've covered nearly all of the markdown syntax basics? When you next create a repository, make a quality Readme file.