Generated file notice in raw MD file

posener / goreadme

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

MIT License

213 stars 31 forks source link

Generated file notice in raw MD file #99

Closed thaney071 closed 3 months ago

thaney071 commented 3 years ago

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 should not be directly edited. This is most useful in team projects were others may not be aware of this tool and make edits to the file directly.

posener commented 3 years ago

This could be added to the template here Would you like to submit a PR?

alexandregv commented 3 months ago

Since this issue is now from 3 years ago, I took the liberty to open a PR for it: #132