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

Rendering awesome-gno README and HTML #58

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

poroburu
Copy link

@poroburu poroburu commented Sep 23, 2024

I have developed a Go program that automatically generates the gno-awesome README from a YAML file.
The content of the YAML was converted from the previous markdown README source of truth.

  • README template correct tolint-awesome.
  • HTML template with rich descriptions stats and media.
  • Github Action workflow for README and HTML triggered by pull request.
  • verify correctness of new YAML content.

RE: #24

Two warnings remain:
* `remark-lint:awesome-github`
* `remark-lint:double-link`
@poroburu poroburu requested a review from a team as a code owner September 23, 2024 02:15
@poroburu poroburu changed the title fix: linted template Rendering awesome-gno README and HTML Sep 23, 2024
@poroburu poroburu marked this pull request as draft September 23, 2024 05:03
Copy link

@wyhaines wyhaines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great start. One suggestion that I have is to implement a simple CI workflow on the repo that does some checks on the YAML -- ensure that the YAML can be parsed in the format expected, ensure that there are no duplicates, etc....

A branch protection rule can probably be setup, in fact, so that a PR merging is blocked if that check fails.

@poroburu
Copy link
Author

poroburu commented Nov 1, 2024

I did a first implementation of the HTML generation. It looks good but it was done by AI on a flight.

go run main.go
Generated Markdown: output/markdown/README.md
Generated HTML: output/html/index.html

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.

2 participants