You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: projects/make-a-github-readme/make-a-github-readme.mdx
+30-16Lines changed: 30 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,15 @@ tags:
23
23
24
24
But did you know that there's a way to personalize your GitHub to make your personality stand out?!
25
25
26
-
It's a profile README! 👤 This is my README for example:
26
+
It's a profile README! This is my README for example. 👤
27
27
28
28
<imgsrc="https://i.imgur.com/egLVWhL.png" />
29
29
30
30
A **README file** is a file in a code repository that tells others about your project, like an introduction. It can explain what a project does, setup information, and credits the project's contributors.
31
31
32
-
It is named **README.md** (the **.md** stands for Markdown, a lightweight way to format text).
32
+
It is named **README.md** (the **.md** stands for Markdown, a lightweight language to format text).
33
33
34
-
In this project tutorial, we're going to make a **profile** README – a file that tells others about YOU! It's the first thing that people see when they land on your GitHub profile. Think of your profile README as an "About Me" page on a website.
34
+
In this project tutorial, we're going to make a **profile** README – a file that tells others about YOU! It's the first thing that people see on your GitHub profile. Think of your profile README as an "About Me" on a website.
35
35
36
36
Let's get started.
37
37
@@ -53,13 +53,14 @@ Now that we have a blank **README.md** file, we're going to add your information
53
53
54
54
Some things you can highlight:
55
55
56
-
- Your school, major, and graduation year
57
-
- Club, internship, and work experience
58
-
- Your proudest accomplishments
59
-
- Fun fact about yourself
60
-
- Anything you want!
56
+
- 👤 Blurb about yourself
57
+
- 🏫 Your school, major, and graduation year
58
+
- 💼 Club, internship, and work experience
59
+
- 🏆 Your proudest accomplishments
60
+
- 🧃 Fun fact about yourself
61
+
- ➕ Anything you want!
61
62
62
-
READMEs are primarily written with **Markdown** – it's a simple language to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links!
63
+
Again, READMEs are primarily written with **Markdown** – it's a simple language to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links!
63
64
64
65
Here's a quick guide on how to mark down your text:
65
66
@@ -77,17 +78,29 @@ Put an asterisk (*), dash (-), or number (1.) before each list item. Each option
77
78
78
79
```markdown
79
80
currently:
80
-
- curriculum @ marketing @ codédex
81
-
- graphic information technlogoy @ arizona state
82
-
- MLH Top 50!
83
-
- hackNY '25
81
+
- 👾 curriculum @ marketing @ codédex
82
+
- 🎨 graphic information technlogoy @ arizona state
83
+
- 🏆 MLH Top 50!
84
+
- ‼️ hackNY '25
84
85
```
85
86
86
87
### Links
87
88
88
-
-**Links:**`(Google)[https://google.com]`
89
-
-**Images:**``
90
-
-**Highlighting code:**````<script> //code here </script>````
89
+
```markdown
90
+
(Google)[https://google.com]
91
+
```
92
+
93
+
### Images
94
+
95
+
```markdown
96
+

97
+
```
98
+
99
+
#### Highlighting code
100
+
101
+
```markdown
102
+
<script> //code here </script>
103
+
```
91
104
92
105
## Personalizing the README
93
106
@@ -120,3 +133,4 @@ You now have your very own README on your profile! We’d love to see what you
120
133
121
134
-[Manging Your Profile README](https://docs.github.com/en/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)
122
135
-[March 2024 GitHub Glow Up Challenge Winners](https://www.codedex.io/community/monthly-challenge/UcTmQlizQK8eVO5hyEeX/winners)
0 commit comments