ggdream / protoc-gen-markdown

markdown doc generator for protobuf

protoc-gen-markdown

install

go install github.com/go-kiss/protoc-gen-markdown

generate markdown

protoc --markdown_out=Mhello.proto=./:. ./hello.proto
# set path prefix to /api
protoc --markdown_out=Mhello.proto=./,prefix=/api:. ./hello.proto

demo

You could check the hello.md to see the result.

doc

I have write a Chinese article to introduce how it works.