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

Can't figure out how godocs fits into this #3

Open
raboley opened this issue Jul 6, 2020 · 1 comment
Open

Can't figure out how godocs fits into this #3

raboley opened this issue Jul 6, 2020 · 1 comment

Comments

@raboley
Copy link

raboley commented Jul 6, 2020

First off I really like this and was able to get it to generate and publish my index.html.md file and custom content there. Where I am a little confused is I hoped that this would somehow magically add documentation from my go package into my slate documentation. Is that a thing this does?

Would be super awesome if I create some markdown in slate style, then the api documentation is generated based on what godocs would create via my commented code.

If this is already a feature any help would be appreciated. I got lost after the build part of the tutorial, and had to do a go run service to get it to actually serve the docs I wrote, but other than that It has been great and I really like this!

@eriknyk
Copy link

eriknyk commented Sep 5, 2022

Same here, can't figure out the way how the docs are filled.

By example https://github.com/swaggo/swag have declarative comments format https://github.com/swaggo/swag#declarative-comments-format

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