Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support of code identifiers #134

Open
pivovarov-art opened this issue Jun 25, 2024 · 2 comments
Open

Support of code identifiers #134

pivovarov-art opened this issue Jun 25, 2024 · 2 comments

Comments

@pivovarov-art
Copy link

pivovarov-art commented Jun 25, 2024

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
Copy link
Author

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
Copy link
Owner

posener commented Jul 1, 2024

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! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants