From 14173bdf1918bf2cf49bd8d9e3b416c56024cc9c Mon Sep 17 00:00:00 2001 From: Gabriela Banaag <40579768+gbanaag@users.noreply.github.com> Date: Wed, 24 Sep 2025 18:10:34 -0400 Subject: [PATCH 1/3] Create make-a-github-readme.mdx --- projects/make-a-github-readme/make-a-github-readme.mdx | 1 + 1 file changed, 1 insertion(+) create mode 100644 projects/make-a-github-readme/make-a-github-readme.mdx diff --git a/projects/make-a-github-readme/make-a-github-readme.mdx b/projects/make-a-github-readme/make-a-github-readme.mdx new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/projects/make-a-github-readme/make-a-github-readme.mdx @@ -0,0 +1 @@ + From 37f24cce153f3cae3bd771dd6a2fc049b8848259 Mon Sep 17 00:00:00 2001 From: Gabriela Banaag <40579768+gbanaag@users.noreply.github.com> Date: Sat, 11 Oct 2025 02:53:51 -0400 Subject: [PATCH 2/3] Update make-a-github-readme.mdx --- .../make-a-github-readme.mdx | 106 ++++++++++++++++++ 1 file changed, 106 insertions(+) diff --git a/projects/make-a-github-readme/make-a-github-readme.mdx b/projects/make-a-github-readme/make-a-github-readme.mdx index 8b137891..921a40d1 100644 --- a/projects/make-a-github-readme/make-a-github-readme.mdx +++ b/projects/make-a-github-readme/make-a-github-readme.mdx @@ -1 +1,107 @@ + +# Make a GitHub Profile README + + + + + +**Prerequisites:** Have a GitHub account +**Read Time:** 10 minutes + +## # Introduction + +[GitHub](https://github.com/) is a platform that allows developers to store, track, share, and collaborate on code. It's a big way to display your technical projects and progress through repositories (a space for project code), with companies often asking for links to your GitHub when you apply to jobs. + + +This is my README! + +

+ +Did you know that there's actually a way to personalize your GitHub to make your personality stand out? In this tutorial, we're going to make a README file about you that's displayed on your profile! + +### ## What's a README file? + +A **README file** is a file in a project repository that tells others about your project. It can explain what a project does, setup information, and credits the projects contributors. + +In this tutorial, we'll be making a **profile** README - a file that tells others about YOU! Think of your profile README as an about me page on a website. + +[Example] + +Make sure you have a GitHub account before we get started! You can create one [here](https://github.com/signup) if you don't have one. + +## # Making the profile README + +1. Make sure you're signed into GitHub. +2. Find the + button in the upper right corner of the header, and then click **New Repository**. +3. You'll be prompted to write a name for your repository. Make this your GitHub username. For example, if your username is `codedex_user`, name your repository `codedex_user`. +4. Select initialize this repository with a README. +5. Make sure the repository is set to **public**. Click **Create repository**. + +## # Editing the README + +Now we're going to add your information to the file. Some things you can highlight: + +- Your school, major, and graduation year +- Club, internship, and work experience +- Your proudest accomplishments +- Links to external sites or social media pages +- Anything you want! + +READMEs are primarily written with **markdown** - it's a way to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links! + +Here's a quick guide on how to mark down your text: + +**- Headers:** `# Header 1` (add more #s to get smaller headers) + +**- Links:** `(Google)[https://google.com]` + +**- Images:** `![](https://images.com/cat_img.PNG)` +- **Highlighting code:** ```````` +- **Lists:** Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively. + +## # Personalizing the README + +There are many plugins and ways to personalize your README! + +- Images that show a glimpse into what you do, or style the README! +- Emojis +- SVGs (Vector images) +- 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! + +## ## Examples for inspo + +Here are some from my friends: + + +Heldanna has a timeline of her job experience in a table! + +

+ + +Grace has a lot of links attached with a nice colored block + logo attached to each link! + +

+ + +Kailey has some cards with stats from her repositories! +

+ + +# # Conclusion + +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. From 6ba5409db5e242a5d853bcd25c050bf7acd1cab5 Mon Sep 17 00:00:00 2001 From: Sonny Li Date: Sun, 12 Oct 2025 00:03:45 -0400 Subject: [PATCH 3/3] Update make-a-github-readme.mdx --- .../make-a-github-readme.mdx | 53 +++++++++++-------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/projects/make-a-github-readme/make-a-github-readme.mdx b/projects/make-a-github-readme/make-a-github-readme.mdx index 921a40d1..8dbdda9f 100644 --- a/projects/make-a-github-readme/make-a-github-readme.mdx +++ b/projects/make-a-github-readme/make-a-github-readme.mdx @@ -1,3 +1,22 @@ +--- +title: Make a GitHub Profile README +author: Gabriela Banaag +uid: CgUQBagDrWWBRUuoh3mkyi3aedg1 +datePublished: 2025-10-12 +description: Learn to make a beautiful GitHub profile README to tell the world about yourself. +header: https://raw.githubusercontent.com/codedex-io/projects/main/projects/build-an-album-finder-with-spotify-api/header.gif +bannerImage: https://raw.githubusercontent.com/codedex-io/projects/main/projects/build-an-album-finder-with-spotify-api/header.gif +published: false +readTime: 30 +prerequisites: GitHub account +versions: None +courses: + - git-github +tags: + - web-development + - beginner +--- + -**Prerequisites:** Have a GitHub account -**Read Time:** 10 minutes - -## # Introduction +## Introduction -[GitHub](https://github.com/) is a platform that allows developers to store, track, share, and collaborate on code. It's a big way to display your technical projects and progress through repositories (a space for project code), with companies often asking for links to your GitHub when you apply to jobs. +[GitHub](https://github.com) is a platform that allows developers to store, track, share, and collaborate on code. It's a big way to display your technical projects and progress through repositories (a space for project code), with companies often asking for links to your GitHub when you apply to jobs. -This is my README! -

+This is my README! Did you know that there's actually a way to personalize your GitHub to make your personality stand out? In this tutorial, we're going to make a README file about you that's displayed on your profile! -### ## What's a README file? +## What's a README file? A **README file** is a file in a project repository that tells others about your project. It can explain what a project does, setup information, and credits the projects contributors. @@ -44,7 +59,7 @@ In this tutorial, we'll be making a **profile** README - a file that tells other Make sure you have a GitHub account before we get started! You can create one [here](https://github.com/signup) if you don't have one. -## # Making the profile README +## Making the profile README 1. Make sure you're signed into GitHub. 2. Find the + button in the upper right corner of the header, and then click **New Repository**. @@ -52,7 +67,7 @@ Make sure you have a GitHub account before we get started! You can create one [h 4. Select initialize this repository with a README. 5. Make sure the repository is set to **public**. Click **Create repository**. -## # Editing the README +## Editing the README Now we're going to add your information to the file. Some things you can highlight: @@ -66,15 +81,13 @@ READMEs are primarily written with **markdown** - it's a way to format plain tex Here's a quick guide on how to mark down your text: -**- Headers:** `# Header 1` (add more #s to get smaller headers) - -**- Links:** `(Google)[https://google.com]` - -**- Images:** `![](https://images.com/cat_img.PNG)` +- **Headers:** `# Header 1` (add more #s to get smaller headers) +- **Links:** `(Google)[https://google.com]` +- **Images:** `![](https://images.com/cat_img.PNG)` - **Highlighting code:** ```````` - **Lists:** Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively. -## # Personalizing the README +## Personalizing the README There are many plugins and ways to personalize your README! @@ -83,25 +96,23 @@ There are many plugins and ways to personalize your README! - SVGs (Vector images) - 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! -## ## Examples for inspo +## Examples for inspo Here are some from my friends: -Heldanna has a timeline of her job experience in a table! +Heldanna has a timeline of her job experience in a table!

Grace has a lot of links attached with a nice colored block + logo attached to each link! -

Kailey has some cards with stats from her repositories!

- -# # Conclusion +## Conclusion 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.