Have you ever written an article on Dev.to that you were particularly proud of? I have. And naturally, I wanted to feature it prominently on my GitHub profile README. I searched for a simple tool to create a nice-looking, dynamic card for my post, but I couldn't quite find what I was looking for.
So, as many of us developers do when faced with a missing tool, I decided to build the solution myself.
Today, I'm happy to share the result with you all: Dev.to Badge, an open-source project that lets you generate beautiful SVG badges for your articles.
What Does It Look Like?
You can create a clean, modern-looking card that automatically pulls information from your post. Here is an example:
With this tool, you can display:
🖼️ The article's cover image
📝 The title and a short description
👤 Your author information
❤️ The number of reactions and comments
🕒 The estimated reading time
How to Use It
Using it is simple. You just need to embed an image in your Markdown file with the provided API.
Using URL:
Using username & slug:
You can easily embed it in your Markdown file (like a GitHub README). Here the example
And that's it! Your profile will now proudly display your featured articles.
👉 To see a full documentation about it. Please check out the project on GitHub: https://github.com/azis14/devto-badge
An Invitation to Collaborate
This project is in its early chapters, and history is best written together. It is completely open source, and contributions are very welcome.
Whether you are interested in fixing bugs, adding new themes, improving the documentation, or suggesting new features, your help would be invaluable. Please feel free to check out the "Issues" tab on the repository to see where you can jump in.
I hope this tool helps you showcase your hard work. Let me know what you think in the comments below!
Top comments (0)