search

posener / goreadme

Generate readme file from Go doc. Now available as a Github action!
MIT License
213 stars 31 forks source link

Support of code identifiers #134

Open pivovarov-art opened 1 week ago

pivovarov-art commented 1 week ago

It would be really nice to support the feature explained here, allowing documenting with cross-links between already documented block of codes, such as structs/funcs/consts/vars.

If it already supported - could you point how to enable it?

pivovarov-art commented 1 week ago

suggestion: if it's not supported yet, I think this feature could be enabled by default, because it's a kind of a part of documenting projects

posener commented 5 days ago

It looks like they don't work.

For example, here is a package with such identifiers:

https://github.com/posener/goreadme/blob/master/testdata/pkg13_stdlib_markdown/pkg1.go

And here is the generated markdown:

https://github.com/posener/goreadme/blob/master/testdata/pkg13_stdlib_markdown/README.md

If we can make it work it would be nice! :)