awesome-gno icon indicating copy to clipboard operation
awesome-gno copied to clipboard

Better rendering of awesome-gno

Open moul opened this issue 2 years ago • 5 comments

What can we make to make the awesome-gno easier to browse, especially when it will have much more content?

I'm thinking about creating a webpage updated after each merge. Or to use a tool to generate richer markdowns, with sections, previews, and stats.

moul avatar Jan 30 '23 10:01 moul

By switching to a new model, we could ask people to register new entries in csv/yaml files so we can have tags; then everything markdown is managed by the engine, not by humans.

If we do this, I expect that links could be linked to "tags/categories" with things like "staff picks", but also to "questions", so we can create an automated FAQ.

moul avatar Feb 09 '23 13:02 moul

this tool can be used to build the awesome page https://github.com/anuraghazra/github-readme-stats

for the tags/categories part, need to do more research, working on it

solofomo avatar Feb 22 '23 06:02 solofomo

My approach is to generate a awesome-lint compatible README from a markdown template. This allows a HTML template to include the rich descriptions stats and media, and be hosted on a GitHub Page or externally. The awesome-gno content is sourced from a YAML file converted from the previous markdown README.

poroburu avatar Sep 23 '24 02:09 poroburu

@poroburu I'd ideally prefer working directly on the markdown rather than editing a yaml. There can be syntaxes understood by the linter and marshalers, but IMO the source of truth should be the markdown.

Counter-arguments welcome. My preference is that 1. i don't particularly like modifying very large yaml files over time and 2. we should be able to add more information and adjust the README dynamically, rather than having to modify a generator in order to change the markdown. -> README is source of truth, rest is derivation

thehowl avatar Sep 23 '24 08:09 thehowl

@thehowl

Some basic repository metadata can be extracted in the traditional awesome list markdown entries. Imagining GitHub repository API stats like: stars, commit graph, contributors.

The yaml entries can contain richer metadata, to be rendered on the HTML. Possibly like this buildwithdotnet example. As this example could not be generated from an awesome-lint markdown readme: https://builtwithdot.net/

Although, if gno-awesome will follow the awesome manifesto and list guidelines. The markdown cannot be generated.

poroburu avatar Sep 25 '24 03:09 poroburu