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
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,9 @@ A **README file** is a file in a code repository that tells others about your pr
31
31
32
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 on your GitHub profile. Think of your profile README as an "About Me" 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. Think of your profile README as an "About Me" on a site.
35
35
36
-
Let's get started.
36
+
Let's get started. ✨
37
37
38
38
## Making the Profile README
39
39
@@ -74,7 +74,7 @@ You can kick off the file with a H1 heading with a single `#`:
74
74
75
75
### Lists
76
76
77
-
Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively.
77
+
Put an asterisk (`*`), dash (`-`), or number (`1.`) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively. For example:
78
78
79
79
```markdown
80
80
currently:
@@ -84,6 +84,8 @@ currently:
84
84
- ‼️ hackNY '25
85
85
```
86
86
87
+
###
88
+
87
89
### Links
88
90
89
91
```markdown
@@ -96,7 +98,7 @@ currently:
96
98

97
99
```
98
100
99
-
####Highlighting code
101
+
### Highlighting code
100
102
101
103
```markdown
102
104
<script> //code here </script>
@@ -109,7 +111,7 @@ There are many plugins and ways to personalize your README!
109
111
- Images that show a glimpse into what you do, or style the README!
110
112
- Emojis
111
113
- SVGs (Vector images)
112
-
- Here’s a [superlist](https://github.com/abhisheknaiidu/awesome-github-profile-readme?tab=readme-ov-file#tools) of things you can embed - everything from stats on what languages you use, visitor counters, jokes, or even music players!
114
+
- Here’s a [superlist](https://github.com/abhisheknaiidu/awesome-github-profile-readme?tab=readme-ov-file#tools) of things you can embed – everything from stats on what languages you use, visitor counters, jokes, or even music players!
113
115
114
116
## Examples for inspo
115
117
@@ -127,7 +129,7 @@ Kailey has some cards with stats from her repositories!
127
129
128
130
## Conclusion
129
131
130
-
You now have your very own README on your profile! We’d love to see what you’ve made - drop your creations on Discord or Codédex OPC.
132
+
You now have your very own README on your profile! We’d love to see what you’ve made – drop your creations on Codédex Discord, Codédex OPC, or Twitter/X.
0 commit comments