Skip to content

Better rendering of awesome-gno #24

Open

Description

@moul

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.

Activity

  1. moul commented on Feb 9, 2023

    @moul
    CollaboratorAuthor

    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.

  2. solofomo commented on Feb 22, 2023

    @solofomo

    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

  3. poroburu commented on Sep 23, 2024

    @poroburu

    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.

  4. thehowl commented on Sep 23, 2024

    @thehowl
    Contributor

    @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

  5. poroburu commented on Sep 25, 2024

    @poroburu

    @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.

  6. moul commented on Nov 5, 2026

    @moul
    CollaboratorAuthor

    Prepared by an AI agent (Claude) on behalf of @moul, 2026-11-05.

    This needs a decision before anyone writes code, so I've laid out the options here instead of opening a PR. The question this thread hasn't settled: what is the source of truth? @thehowl wants the README, while #58 (draft, conflicting) uses YAML.

    A. The README stays the source of truth, and we generate a static page from it. A GitHub Action parses README.md (it's already lint-clean, one - [name](url) - desc. per line) and builds a single HTML page on GitHub Pages, with search, a section filter, and stars/last-push pulled from the GitHub API at build time. Contributors' workflow stays the same. Cost: about one afternoon. Tags would have to be inline markers (e.g. <!-- tags: wallet -->).

    B. YAML becomes the source of truth, and the README is generated (#58). This gives the richest metadata (tags, staff picks, FAQ links, media). The downsides: contributors edit YAML instead of markdown, CI has to reject hand edits to the README, and it reverses @thehowl's stated preference. #58 would need a rebase plus the HTML half finished.

    C. Render it on gno.land. A realm such as r/gnoland/awesome gets synced from the README by CI. It's on-brand and dogfoods gnoweb, but it adds a deploy key and a chain dependency to a markdown list.

    D. Leave it as is. With roughly 70 entries and a ToC, the README still browses fine on GitHub.

    Recommendation: A. It's the cheapest option, it keeps the README as the source of truth, and it can be extended to C later by reusing the same parser. If the maintainers agree, it's a small, contained PR. If we go with B, #58 is the starting point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions