goreadme icon indicating copy to clipboard operation
goreadme copied to clipboard

Generate readme file from Go doc. Now available as a Github action!

Results 14 goreadme issues
Sort by recently updated
recently updated
newest added

[pre-commit](https://github.com/pre-commit/pre-commit) is "A framework for managing and maintaining multi-language pre-commit hooks", so kinda like a local CI. It's a popular tool with a lot of community-made hooks. I thought it...

It would be really nice to support the feature explained [here](https://pkg.go.dev/github.com/fluhus/godoc-tricks#hdr-Documentation_Links), allowing documenting with cross-links between already documented block of codes, such as structs/funcs/consts/vars. If it already supported - could...

Unless supplying `-types -methods`, goreadme fails to include `ExampleT_M`-typed examples. The documentation is not clear about this behavior or the needed remedy. The testing package mentions that there are several...