Skip to content
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.

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

Add shields for Github projects #118

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

rschroll
Copy link
Contributor

@rschroll rschroll commented Feb 8, 2021

As I look through projects to see if they will be of use to me, there's a few things that I want to know right away: language, license, and project activity. Right now, I have to click on each project to check it out on Github (for the vast majority), so I wondered if there was a way to present that information directly on this page.

This PR demos a way of doing this with shields.io. You can see the end result here: https://github.com/rschroll/awesome-reMarkable/blob/shields/README.md. It's probably a bit too busy, but I wanted to show several options. If it were up to me, I'd probably dump the issue count and possibly the language for things other than libraries. But I'm curious what other people would find useful.

There's no way I'd do all of this by hand, and shields.py is the short Python script I wrote to manage the process. Presumably this could be put into some sort of CI process to automate the addition of these badges as new entries are added.

We could manually add badges for the few non-Github projects, but we'd probably only want to do this for properties that don't often change.

If this is interesting, let me know and I'm happy to iterate on the design a bit.

@beardhatcode
Copy link

Hmmm, I feel like this could be automated and should not be in the markdown file. Maybe a GitHub action could make a nice HTML page to serve trough GitHub pages? That would be super awesome

@rschroll
Copy link
Contributor Author

rschroll commented Feb 9, 2021

As I worked on this, I started to think, could each item be stored in a JSON doc, and then a build system assemble them into a bunch of pages, some by topic, some by language, some by OS, etc. And then I remembered that this is a side project to my side project. If someone wants to use this as a base for that sort of project, please do!

A simpler solution for now might be to copy the existing README.md into a source.md file, and then have a CI action update the README.md file from source.md, adding in the shields. This would make the github project still be the place to view, while keeping a more editable source for the future.

@Ameb
Copy link
Member

Ameb commented Feb 22, 2021

You won't believe me but back in october i started the idea of creating a Jekyll site and exported the list to a json, but i prefer to format them as multiple documents in a single folder.

With both solutions we can generate a site with Jekyll, https://ameb.github.io/awesome-reMarkable/collection/

It is a WIP. I want to be able to filter them dinamically with javascript, and allows for bigger descriptions

@lapwat
Copy link
Contributor

lapwat commented Mar 26, 2021

Cool feature, filter projects by popularity would be great

@Ameb
Copy link
Member

Ameb commented Apr 7, 2021

To filter github projects by popularity, check the github topic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants