Add Color to Text in Read Me File
Writing Github README
README is what attracts developers/visitors to view your project. If your README contains merely manifestly text, AHHH, information technology's not convincing. It is like subject field books as you lot grow up; with less pictures, small font, big paras and no interest. I judge it is not just me who used to search for pictures in the book to gauge how interesting it would exist, how much I would read it in time to come, or if I would even bear on it.
If I write this weblog without whatsoever pictures🖼️, same sized font🔤, no separations, no humor🤡, no anecdotes; in short no interest❌; I am technically writing it in vain. Information technology's non gonna get sold and I am gonna remain poor. POOR ME😭. I don't know how much interesting I tin can make this web log merely I promise it can help you.
README is the face up of your project and you lot need to apply the all-time makeup on to brand it look sufficiently presentable so you lot won't loose YOUR Face. And then, allow's get-go and get to know what all we have for the MAKEUP and how to apply information technology.
Makeup Kit includes :-
- Headings
- Linebreaks
- Accent
- Blockquotes
- Don't render Lawmaking
- Lists — ordered and unordered
- Horizontal rules
- Links
- Images/GIF
- Video
- Labels
- Tables
- Task List
- Add Color
- Write text as lawmaking
- Add together Emoji
All in 1 kit. No improve place to go. Let's begin
1. Headings
Same as in HTML, here you accept 6 headings.
Code :-
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading6
A line is given by default for Heading1 and Heading2. Others are without it.
two. Line Breaks
For a line break or writing to a new line yous can either opt the markdown way or the HTML way. Both works fine.
Markdown :- To create a line break, finish a line with two or more spaces, and hit enter.
Markdown Manner
of breaking
Lamentable, they won't let more 1 space here so copy pasting the above code won't piece of work for you.
HTML :- Just add together the break tag (<br>)
HTML way <br>
of breaking
3. Emphasis
Assuming and Italic are the ii emphasis modes. It adds a petty weight to your monotonous text.
Bold :- Doubles are for bold
**Bold**
__Bold__
Italic :- Singles are for italic
*Italic*
_Italic_
What if we want both, a HYBRID ?
***Hybrid***
___Hybird___
**_Hybrid_**
*__Hybrid__*
iv. Blockquotes
Blockquotes are quotes that are ready off from the chief text equally a paragraph, or block of text.
Code :- (The > on 2nd line is for an empty line in output)
> This is a blockquote
>
> This is next line
Nested Blockquote
> This is master Blockquote
> >This is nested Blockquote
> >
> >Permit's go out of nested
>
> Allow'southward become out of main
5. Code
"Don't render it. I said DON'T. Keep information technology as a code."
Write the code and requite a tab to all, i.eastward. four spaces. Indent them by iv spaces to proceed them as a normal text. If you don't indent information technology, it will be read every bit an HTML block.
Code :- (More than 1 space not allowed hither)
<html>
<body>
<p>Let's keep it as a code block and not return it for one time</p>
</body>
</html>
6. Lists
Lists are very necessary for README like when y'all desire to list the features, or languages used, etc.
Unordered List :-
* Item1
* Item2
* Item3- Item1
- Item2
- Item3
Ordered Listing :-
i. Item1
2. Item2
3. Item3
7. Horizontal Rules
To create a horizontal dominion, use three or more than asterisks (***), dashes (---), or underscores (___).
---
****
_______
8. Links
To create a link, enclose the link text in brackets and then follow information technology immediately with the URL in parentheses. You lot can also merely copy paste a link.
[Link to Portfolio Website](https://gaganpreetkaurkalsi.netlify.app/)
Link with title :-
[Link to Portfolio Website](https://gaganpreetkaurkalsi.netlify.app "My Portfolio Website")
9. Images
Images are very important to make your README attractive.
To place an image,
- upload it to your repository
- mention its path in the below given markdown
GIF — Y'all can also upload a GIF. Merely mention its link in place of image link. The syntax remains same.
You can also elevate and drop an paradigm in the README. This characteristic has been added recently.
x. Video
Same as Image you can upload a video to your README. Make a short video of your project and paste it to proceeds more than viewers.
11. Labels
Hither is code to a few labels below. Feel gratis to apply. Mention your Github Username and repository name in the space mentioned.
For more such labels visit https://shields.io/
12. Table
Well I haven't used them withal in whatsoever of my projects but maybe yous were but looking for it and I saved y'all.
You can create tables with pipes | and hyphens -. Hyphens are used to create each column's header, while pipes separate each column. At that place must be at least iii hyphens in each column of the header row. Re-create pasting code won't work.
| Header1 | Header2 | Header3 |
| — — — | — — — — — -| — — — — — |
| R1C1 | R1C2 | R1C3 |
| R2C1 | R2C2 | R2C3 |
Table with Alignment :-
To align items :-
- Left Align —
:--- - Center Align —
:---: - Right Align —
---:
| Header1 | Header2 | Header3 |
|:----|:----:|----:|
| R1C1 | R1C2 | R1C3 |
| R2C1 | R2C2 | R2C3 |
Note :- Copy pasting codes won't work. I tested it. Just write on your ain and it will be fine
13. Chore List
Just another thing y'all can effort to fit in somewhere in your README.
- [ten] Write a blog
- [x] Make it interesting
- [ ] Publish it
xiv. Add Color
Don't know what this is or how I can apply information technology, but I came through this when searching for how I tin can add colors. I don't think GOOGLE got me. Only as I am documenting all, why leave this behind. No Prejudice.
```diff
- This is a crimson colored line
+ This is a green colored line
@@ This is a purple colored line @@
```
fifteen. Write text as Lawmaking
Do you wanna put a grey background to your text and make it announced every bit a code segment. This is what you demand.
`How-do-you-do This is a code`
`` Using `single back ticks` within double back ticks``
16. Add Emoji 😊
Last simply not the least, do you lot wanna add together some emojis to your README. Here is how to practice it.
- Get to https://emojipedia.org/
- Search for the perfect emoji
- Copy and paste it in the README
I know many of y'all might know this. But still for those who don't. It is cool.
I guess that's information technology. I take documented all the useful markdowns which you tin add to your README. Make it beautiful and make every client fall in honey🥰 with information technology. Remember it is the Confront. Put makeup in a decent way.
Hither is the link to i of my README which I created recently. I seriously couldn't remember how to write information technology. As a effect, I thought of writing a blog so if future me somehow forgets once again it is only a copy, paste and an enter away. If y'all like it call back to give repo a star⭐.
Hither are some links where you tin can reach me
Email — gagansinghkalsi4126@gmail.com
Github — https://github.com/GaganpreetKaurKalsi
I hope I was of whatever aid and able to reduce a piffling of your efforts past putting everything at one identify. If yous like information technology, please give a clap👏 and I will give a pat on my dorsum.
Thank you!
Run across you lot all! Bye 👋
Source: https://medium.com/analytics-vidhya/writing-github-readme-e593f278a796
0 Response to "Add Color to Text in Read Me File"
Post a Comment