search

growler / go-slate

A CLI tool to generate API documentation using Slate layout by Robert Lord
MIT License
23 stars 8 forks source link

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

Open raboley opened 4 years ago

raboley commented 4 years ago

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 commented 2 years ago

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