goreadme
goreadme copied to clipboard
posener
Generate readme file from Go doc. Now available as a Github action!
👋 @posener. We're using this action to generate our readme [over here](https://github.com/deliveryhero/pipeline) and I noticed that all of our badges were broken (our `master` branch is called `main`). I added...
Adds a flag to override the destination output. The reason for adding a flag override in addition to the env setting is for easier usage with go generate and for...
I can understand you were trying to make things more automatic but please replace the the check for at: https://github.com/posener/goreadme/blob/master/cmd/goreadme/main.go#L120 To require this to be a flag instead of assuming...
Seems for some of the badges, the Branch name is hardcoded into the template. Would be good to make that dynamic as Github has changed the defaults from master to...
i used goreadme in some projects and i really love it. today i started a new project and tried to use goreadme.... it just produces the default output ```sh $...
The only way to make a file using this tool as CLI is to redirect the stdout to a file. It would be helpful to have a flag for where...
It would be nice if the tool could add a comment to the .md output as an html comment so that it is clear that the file is generated and...
Add "destination-path" option to allow picking the destination of all the generated readme files. This allows saving all the documentation in a subfolder like `docs` inside a repository. Example `goreadme...
Hi there, thanks for a nice tool. I'm running it with: ``` goreadme --skip-examples --badge-godoc --badge-goreportcard ``` directly from the project, and I notice that even though the project name...
Would be useful to be able to import and use `ToMarkdown` as defined in here https://github.com/posener/goreadme/blob/master/internal/markdown/comment.go#L284. Might be helpful to just the internal `package` altogether. Not sure...
