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.

Sign up for GitHub

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

Jump to bottom

Use ponzu to make docs #2

Open

ghost opened this issue Oct 9, 2018 · 0 comments

ghost commented Oct 9, 2018

It's possible to use Hugo but we can actually make it work off the go code in ponzu.

Godoc to markdown.
Markdown into Hugo.
Ponzu running under it all watching the source GitHub tags and kicking it off.

I think by using ponzu the search functionality will be much better in the web GUI.

I think this is just a matter of bolting together the right pieces.

Here is a noteworthy example that uses this same approach.
https://snipcart.com/blog/golang-ecommerce-ponzu-cms-demo

This will mean that people that build ponzu add-ons or full projects also get this automatic documentation system too

This is also a good PR for someone starting ponzu.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment