search

intergrav / devins-badges

Open-source library of beautifully designed badges for various services
https://intergrav.github.io/devins-badges-docs/
MIT License
334 stars 23 forks source link

Categorize badges and maybe preview page? #8

Closed Andre601 closed 1 year ago

Andre601 commented 1 year ago

It could be useful to put the images/SVGs into separate folders based on what they are for.

f.e. spigot or plugins containing the badges for platforms supported or downloads for badges about where you can download them from.

As an example: badges/downloads/modrinth_vector.svg

Another thing that could be nice to add is a page to preview the badges. Something like a PREVIEW.md that would display the badges and also show their Markdown-code to use. Would allow people to more easily know what badges look like.

If wanted can I work on this myself and PR it later on.

intergrav commented 1 year ago

This may break some of the badges people are currently using, but I could give it a try. Maybe I'll keep a legacy badges folder, and then have a new assets folder which is the one that should be used.

intergrav commented 1 year ago

Should this be counted as documentation? Or moved somewhere else.

image

intergrav commented 1 year ago

This is what I have done for organization

image

Andre601 commented 1 year ago

This may break some of the badges people are currently using, but I could give it a try. Maybe I'll keep a legacy badges folder, and then have a new assets folder which is the one that should be used.

Maybe use GitHub pages for this? Like have the new badges on a github.io domain while keeping the old ones where they are right now. Another alternative would be to create a new branch as the default to use while putting the current one as a separate branch. That way should image links remain the same, while you can provide a new format.

Should this be counted as documentation? Or moved somewhere else.

image

Would say it counts towards documentation, yeah.

intergrav commented 1 year ago

I think going the github pages way works out, because I was going to make a website for this anyway (not an automated badge picker though, idk how to do that)