Skip to content

Commit 880a46b

Browse files
authored
Update make-a-github-readme.mdx
1 parent 9826e3e commit 880a46b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

projects/make-a-github-readme/make-a-github-readme.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ A **README file** is a file in a code repository that tells others about your pr
3131

3232
It is named **README.md** (the **.md** stands for Markdown, a lightweight language to format text).
3333

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.
3535

36-
Let's get started.
36+
Let's get started.
3737

3838
## Making the Profile README
3939

@@ -74,7 +74,7 @@ You can kick off the file with a H1 heading with a single `#`:
7474

7575
### Lists
7676

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:
7878

7979
```markdown
8080
currently:
@@ -84,6 +84,8 @@ currently:
8484
- ‼️ hackNY '25
8585
```
8686

87+
###
88+
8789
### Links
8890

8991
```markdown
@@ -96,7 +98,7 @@ currently:
9698
![](https://images.com/cat_img.PNG)
9799
```
98100

99-
#### Highlighting code
101+
### Highlighting code
100102

101103
```markdown
102104
<script> //code here </script>
@@ -109,7 +111,7 @@ There are many plugins and ways to personalize your README!
109111
- Images that show a glimpse into what you do, or style the README!
110112
- Emojis
111113
- 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!
113115

114116
## Examples for inspo
115117

@@ -127,7 +129,7 @@ Kailey has some cards with stats from her repositories!
127129

128130
## Conclusion
129131

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.
131133

132134
### More Resources
133135

0 commit comments

Comments
 (0)