posener/goreadme
Generate readme file from Go doc. Now available as a Github action!
This project helps Go package maintainers keep their documentation consistent. It takes the structured comments from your Go source code (Go doc) and automatically generates a well-formatted README.md file. The ideal user is a Go developer managing an open-source library or internal package who wants to ensure their public-facing documentation always reflects their code.
219 stars. No commits in the last 6 months.
Use this if you are a Go developer who wants to automatically generate and update your repository's README file directly from your Go code documentation.
Not ideal if you need highly customized README formatting that goes beyond what can be expressed within standard Go doc conventions and markdown extensions.
Stars
219
Forks
31
Language
Go
License
MIT
Category
Last pushed
Oct 18, 2024
Commits (30d)
0
Get this data via API
curl "https://pt-edge.onrender.com/api/v1/quality/ai-coding/posener/goreadme"
Open to everyone — 100 requests/day, no key needed. Get a free key for 1,000/day.
Higher-rated alternatives
googleapis/gapic-generator-python
Generate Python API client libraries from Protocol Buffers.
zeromicro/go-zero
A cloud-native Go microservices framework with cli tool for productivity.
omissis/go-jsonschema
A tool to generate Go data types from JSON Schema definitions.
openconfig/ygot
A YANG-centric Go toolkit - Go/Protobuf Code Generation; Validation; Marshaling/Unmarshaling
mailru/easyjson
Fast JSON serializer for golang.