docgen

README

Docgen

Docgen is a plugin of gunk. For now, it goes through the same gunk package used in gunk generate command and generates a documentation markdown file all.md and a messages.pot.

The messages.pot files contains all strings from the openapi annotations.

Installation

Use the following command to install docgen:

$ go get -u github.com/gunk/gunk/docgen

This will place docgen in your $GOBIN

Usage

In your .gunkconfig add the following:

[generate]
command=docgen
out=examples/util/v1/

Code examples

To generate code examples, add the following to the .gunkconfig docgen section:

lang=go

Then add your *.go files near your gunk files. The examples files must be named according to the gunk method you want to showcase.

Example:

// UpdateAccount updates an account.
UpdateAccount(UpdateAccountRequest)

// DeleteAccount deletes an account.
DeleteAccount(DeleteAccountRequest)

You should have update_account.go and delete_account.go.

Contributing

After any changes on templates/api.md, make sure to perform go generate in assets folder to embed your changes.