I made the best Github ReadMe EVER!

Milk — Sun, 04 Sep 2022 12:07:54 +0000

AFAIK there is no legit people-led and voted ranking awards for Github ReadMe. But you'll be the judge if it really is the best github you've ever seen.

Here's how you can do it, too:

Intro PNG

I made the PNG from carbon, where you can generate screenshots of your code. You could also export it as SVG if you want to add animation or other customizations to the file.

After exporting the PNG, I edited the file in Figma to add custom text and a bot model.

Snake Contribution Graph

The graph is from my actual github graph. And snake eats them like that classic snake game from our good old Nokia phones.
I used this github action to make it.

Animated SVG

Click the animation for the source code. Yes! It's not a GIF and yes you can animate SVGs and it can be used for your ReadMe.

The typing SVG is generated from here. Adjust the parameters as you like.

Lighthouse Stats

I got the image generated from here. Then, I just customized the text in Figma.

Tables

Here are the best practices for markdown. Here, you'll see the many ways to create tables and format your Github ReadMe.

Support Button

It was generated from Ko-fi's site. I got it from their widgets tab. From there you can customize your button however you like. I chose Ko-Fi because they don't take fees from the sponsorships you get and you can use Paypal or Stripe. Of course, you can also replace this button with your preferred platform.

Shields or Badges for Social Sites

I used shields.io. They offer many ways to customize the look of your badges.

Live Spotify Stream

It shows my recent stream or what I'm listening to real-time. I used this. You'll have to authenticate with your Spotify account. You can also customize the theme.

Auto-updated Workflow for Feeds and Blog

This workflow lists scraped RSS or feed from any of my blogs from different platforms. I used this Github Action.

Github Stats

I used this to generate them.

![Github Stats of Milk](https://github-readme-stats.vercel.app/api?username=GithubUsername&show_icons=true&theme=buefy)
![Profile Stats of Milk](https://github-readme-stats.vercel.app/api/top-langs/?username=GithubUsername&layout=compact&hide=html&theme=buefy)

Just replace GithubUsername with your username and you're good to go.

Visitor Count Badge

Here's the exact code used to generate these badges:

![Visitor Count Badge](https://komarev.com/ghpvc/?username=GithubUsername&label=Profile%20views&color=0e75b6&style=flat)

![Visitor Count Badge - Classic](https://komarev.com/ghpvc/?username=GithubUsername&label=Profile%20views&color=0e75b6&style=flat)

Just replace GithubUsername with your username and you're good to go.

Here's another way to do it. Look in here for style options.

Check out other Github ReadMe

Here's a site to look up other people's profiles.
You can also find a list of tools to help you build the best possible Github ReadMe. There are plenty of profile generators out there to make your life easier.

Lastly, I privated my github for the less cluttered look of my github page. Also, it helps not spam my friends whenever I'm on a starring rampage or commiting and making too many pull requests.
It's a beta feature. Try it for yourself. It's in settings.

milkshakegum (Milk) · GitHub

Too obsessed with making tools to make everyday life easier. #cope Fueled with caffeine, ADHD and OCD. - milkshakegum

github.com

Time to unleash your creativity. Good luck! -Milk

Change-log:

Thank you so much for appreciating my work!
I took into consideration all the feedback you guys gave me.

Added proper ALT tags.
Made as much HTML into Markdown, if it won't work in Markdown I at least added whitespaces to make it still readable.
Corrected misspelled words.
Changed the previous theme to a much accessible one.

DEV Community: Milk