Skip to content

Commit f26e1ca

Browse files
authored
Update make-a-github-readme.mdx
1 parent a1b4968 commit f26e1ca

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

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

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ tags:
2323

2424
But did you know that there's a way to personalize your GitHub to make your personality stand out?!
2525

26-
It's a profile README! 👤 This is my README for example:
26+
It's a profile README! This is my README for example. 👤
2727

2828
<img src="https://i.imgur.com/egLVWhL.png" />
2929

3030
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.
3131

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

3636
Let's get started.
3737

@@ -53,13 +53,14 @@ Now that we have a blank **README.md** file, we're going to add your information
5353

5454
Some things you can highlight:
5555

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!
6162

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!
6364

6465
Here's a quick guide on how to mark down your text:
6566

@@ -77,17 +78,29 @@ Put an asterisk (*), dash (-), or number (1.) before each list item. Each option
7778

7879
```markdown
7980
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
8485
```
8586

8687
### Links
8788

88-
- **Links:** `(Google)[https://google.com]`
89-
- **Images:** `![](https://images.com/cat_img.PNG)`
90-
- **Highlighting code:** ````<script> //code here </script>````
89+
```markdown
90+
(Google)[https://google.com]
91+
```
92+
93+
### Images
94+
95+
```markdown
96+
![](https://images.com/cat_img.PNG)
97+
```
98+
99+
#### Highlighting code
100+
101+
```markdown
102+
<script> //code here </script>
103+
```
91104

92105
## Personalizing the README
93106

@@ -120,3 +133,4 @@ You now have your very own README on your profile! We’d love to see what you
120133

121134
- [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)
122135
- [March 2024 GitHub Glow Up Challenge Winners](https://www.codedex.io/community/monthly-challenge/UcTmQlizQK8eVO5hyEeX/winners)
136+
- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/markdown-cheatsheet)

0 commit comments

Comments
 (0)