Skip to content

Fixes#1018: Improved markdown and code snippets in Fun Profile Customization #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2025
Merged

Fixes#1018: Improved markdown and code snippets in Fun Profile Customization #1031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bb4eda
Refactored Fun Profile Customizations
steam-bell-92 Oct 22, 2025
c769283
Merge branch 'recodehive:main' into main
steam-bell-92 Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/GitHub/Fun-Profile-Customizations/Anurag-Hazra's-GitHub-Readme-Cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ This is the foundational tool for dynamic profile statistics. It uses a serverle

To use these cards, you simply embed them as images in your `README.md`. **Replace `YOUR_USERNAME` with your actual GitHub username.** The code below uses the popular `buefy` theme.

```markdown
## My GitHub Stats

```markdowm
[![GitHub Stats](https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true&theme=buefy&hide_rank=true)](https://github.com/anuraghazra/github-readme-stats)
```

## Top Languages

```markdown
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=YOUR_USERNAME&layout=compact&theme=buefy&exclude_repo=recode-hive-docs,test-repo)](https://github.com/anuraghazra/github-readme-stats)
```

### Customization: Themes and Layouts

Expand Down Expand Up @@ -53,4 +56,4 @@ This parameter is most commonly used for the Top Languages card to optimize spac

⚠️ **Important Note on Language Calculations:** The Top Languages card calculates language usage from all public repos you own. To ensure the card accurately reflects your coding focus (and not just boilerplate files), it is strongly recommended to use the &exclude_repo= parameter to ignore repositories containing auto-generated documentation or simple configuration.

🔗 Relevant Repo: ![Anurag Hazra's GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats)
🔗 Relevant Repo: <a href="https://github.com/anuraghazra/github-readme-stats">Anurag Hazra's GitHub Readme Stats</a>
4 changes: 2 additions & 2 deletions docs/GitHub/Fun-Profile-Customizations/Snake-Contribution-Animation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Snake Contribution Animation 🐍
# Snake Contribution Animation

The Snake Contribution Animation is a visually unique and engaging way to represent your yearly activity. This feature adds a looping GIF or SVG of a "snake" chasing and consuming your contribution blocks, creating a dynamic element on your profile.

Expand Down Expand Up @@ -52,9 +52,9 @@ jobs:
```
Once your workflow runs successfully (you can check the Actions tab on GitHub), the generated file will be saved to your repository. Embed the image in your main README.md using the path where the action saved the file:

```markdown
## My 2024 GitHub Activity

```markdown
![Snake Animation](https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/github-snake.svg)
```

Expand Down
8 changes: 6 additions & 2 deletions docs/GitHub/Fun-Profile-Customizations/Trophy-Case-Streaks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,21 @@ To include the trophy case, simply embed the SVG image link in your Readme, repl

### My Trophy Case

```markdown
[![GitHub Trophies](https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=gruvbox&no-frame=true)](https://github.com/ryo-ma/github-profile-trophy)
```

🔗 Relevant Repo: ![ryo-ma/github-profile-trophy](https://github.com/ryo-ma/github-profile-trophy)
🔗 Relevant Repo: <a href="https://github.com/ryo-ma/github-profile-trophy">ryo-ma/github-profile-trophy</a>

### GitHub Streaks 🔥
This card displays your current streak of contributions and your longest historical streak, promoting a daily habit of coding. Seeing your streak number grow can be a powerful psychological push!

**Setup Example:**

```markdown
[![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=YOUR_USERNAME&theme=highcontrast&date_format=j+M+Y)](https://github.com/DenverCoder1/github-readme-streak-stats)
```

🔗 Relevant Repo: ![DenverCoder1/github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)
🔗 Relevant Repo: <a href="https://github.com/DenverCoder1/github-readme-streak-stats">DenverCoder1/github-readme-streak-stats</a>

💡 Tip: To maintain a streak, remember that contributions count if they are made within a 24-hour period, based on UTC time.
10 changes: 5 additions & 5 deletions docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🎨 Fun GitHub Profile Customizations
# Fun GitHub Profile Customizations

Your GitHub profile Readme is a prime piece of digital real estate. It’s more than just a list of code repositories—it's your developer brand, your digital workshop, and your **first impression** on the global coding community. Customizing it is essential for promoting the dynamic developer culture of Recode Hive and maximizing your personal visibility.

Expand All @@ -16,10 +16,10 @@ Before you can add any dynamic stats or flair, you must complete the single, mos

Once your profile repo is set up, customization offers tangible benefits that go far beyond aesthetics:

1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
- 1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
Copy link
Contributor

@vercel vercel bot Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The numbered list formatting is incorrect, mixing bullet point syntax with numbering (- 1., - 2., etc.) instead of standard markdown numbered list format.

View Details
📝 Patch Details 
diff --git a/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md b/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
index 47962cd..fd96552 100644
--- a/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
+++ b/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
@@ -16,10 +16,10 @@ Before you can add any dynamic stats or flair, you must complete the single, mos
 
 Once your profile repo is set up, customization offers tangible benefits that go far beyond aesthetics:
 
-- 1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
+1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
 
-- 2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.
+2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.
 
-- 3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.
+3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.
 
-- 4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
\ No newline at end of file
+4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
\ No newline at end of file
diff --git a/docs/GitHub/GitHub-basics/create-github-repo.md b/docs/GitHub/GitHub-basics/create-github-repo.md
index 38065fc..a53c8b6 100644
--- a/docs/GitHub/GitHub-basics/create-github-repo.md
+++ b/docs/GitHub/GitHub-basics/create-github-repo.md
@@ -12,8 +12,8 @@ To create and host a project, the repository is a place where you add all your p
 
 ### Prerequisites
 
-- 1. You must have a GitHub account. 
-- 2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
+1. You must have a GitHub account. 
+2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
 
 ### How to create Github Repository
 
diff --git a/docs/GitHub/Maintainer-guide/enable-discussion.md b/docs/GitHub/Maintainer-guide/enable-discussion.md
index ee03702..e2366a8 100644
--- a/docs/GitHub/Maintainer-guide/enable-discussion.md
+++ b/docs/GitHub/Maintainer-guide/enable-discussion.md
@@ -12,8 +12,8 @@ In order to create a project and host, the repository is a place where you add a
 
 ### Prerequisites
 
-- 1. You must have a GitHub account. 
-- 2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
+1. You must have a GitHub account. 
+2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
 
 
 ### How to create GitHub Repository
diff --git a/docs/GitHub/Maintainer-guide/github-labels.md b/docs/GitHub/Maintainer-guide/github-labels.md
index 62dc98e..6271711 100644
--- a/docs/GitHub/Maintainer-guide/github-labels.md
+++ b/docs/GitHub/Maintainer-guide/github-labels.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
 
 ### Prerequisites
 
-- 1. You should have a Github account 
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account 
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
 
 ### How to create Github Repository
 
diff --git a/docs/GitHub/Maintainer-guide/github-project.md b/docs/GitHub/Maintainer-guide/github-project.md
index 5841bc5..d15c5d1 100644
--- a/docs/GitHub/Maintainer-guide/github-project.md
+++ b/docs/GitHub/Maintainer-guide/github-project.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
 
 ### Prerequisites
 
-- 1. You should have a Github account 
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account 
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
 
 ### How to create Github Repository
 
diff --git a/docs/GitHub/Maintainer-guide/milestone.md b/docs/GitHub/Maintainer-guide/milestone.md
index 86d5975..283a1c5 100644
--- a/docs/GitHub/Maintainer-guide/milestone.md
+++ b/docs/GitHub/Maintainer-guide/milestone.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
 
 ### Prerequisites
 
-- 1. You should have a Github account 
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account 
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
 
 ### How to create Github Repository

Analysis

Incorrect numbered list formatting in multiple markdown files

What fails: Numbered lists in 6 documentation files use incorrect - 1. format (mixing bullet point and numbering syntax) instead of standard markdown 1. format

How to reproduce:

  1. Check markdown files: docs/GitHub/Fun-Profile-Customizations/Why-Customize.md lines 19-25
  2. View other affected files: docs/GitHub/GitHub-basics/create-github-repo.md, docs/GitHub/Maintainer-guide/enable-discussion.md, etc.
  3. Compare with proper numbered lists used elsewhere in the same repository

Result: Lists render as bullet points containing numbered text instead of proper ordered lists. Format - 1. creates unordered list items, not numbered sequences.

Expected: Standard markdown numbered lists using 1., 2., 3. format per GitHub's markdown documentation


2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.
- 2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.

3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.
- 3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.

4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
- 4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
2 changes: 1 addition & 1 deletion sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const sidebars: SidebarsConfig = {
},
{
type: "category",
label: "🎨 Fun Proflie Customizations",
label: "Fun Proflie Customizations",
className: "custom-sidebar-fun",
items: [
"GitHub/Fun-Profile-Customizations/Why-Customize",
Expand Down
Loading