Skip to content

Commit 8e97fa2

Browse files
authored
Merge pull request #1031 from steam-bell-92/main
Fixes#1018: Improved markdown and code snippets in Fun Profile Customization
2 parents 2dd2ddf + c769283 commit 8e97fa2

File tree

5 files changed

+19
-12
lines changed

5 files changed

+19
-12
lines changed

docs/GitHub/Fun-Profile-Customizations/Anurag-Hazra's-GitHub-Readme-Cards.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,17 @@ This is the foundational tool for dynamic profile statistics. It uses a serverle
1111

1212
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.
1313

14-
```markdown
1514
## My GitHub Stats
1615

16+
```markdowm
1717
[![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)
18+
```
1819

1920
## Top Languages
2021

22+
```markdown
2123
[![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)
24+
```
2225

2326
### Customization: Themes and Layouts
2427

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

5457
⚠️ **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.
5558

56-
🔗 Relevant Repo: ![Anurag Hazra's GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats)
59+
🔗 Relevant Repo: <a href="https://github.com/anuraghazra/github-readme-stats">Anurag Hazra's GitHub Readme Stats</a>

docs/GitHub/Fun-Profile-Customizations/Snake-Contribution-Animation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Snake Contribution Animation 🐍
1+
# Snake Contribution Animation
22

33
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.
44

@@ -52,9 +52,9 @@ jobs:
5252
```
5353
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:
5454
55-
```markdown
5655
## My 2024 GitHub Activity
5756
57+
```markdown
5858
![Snake Animation](https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/github-snake.svg)
5959
```
6060

docs/GitHub/Fun-Profile-Customizations/Trophy-Case-Streaks.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@ To include the trophy case, simply embed the SVG image link in your Readme, repl
1111

1212
### My Trophy Case
1313

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

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

1820
### GitHub Streaks 🔥
1921
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!
2022

2123
**Setup Example:**
2224

25+
```markdown
2326
[![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)
27+
```
2428

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

2731
💡 Tip: To maintain a streak, remember that contributions count if they are made within a 24-hour period, based on UTC time.

docs/GitHub/Fun-Profile-Customizations/Why-Customize.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🎨 Fun GitHub Profile Customizations
1+
# Fun GitHub Profile Customizations
22

33
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.
44

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

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

19-
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.
19+
- 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.
2020

21-
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.
21+
- 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.
2222

23-
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.
23+
- 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.
2424

25-
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.
25+
- 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.

sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const sidebars: SidebarsConfig = {
7070
},
7171
{
7272
type: "category",
73-
label: "🎨 Fun Proflie Customizations",
73+
label: "Fun Proflie Customizations",
7474
className: "custom-sidebar-fun",
7575
items: [
7676
"GitHub/Fun-Profile-Customizations/Why-Customize",

0 commit comments

Comments
 (0)