{"repo":"pseudomuto/protoc-gen-doc","free":true,"listed":false,"github":"https://github.com/pseudomuto/protoc-gen-doc","clone":"git clone https://github.com/pseudomuto/protoc-gen-doc.git","description":"Documentation generator plugin for Google Protocol Buffers","language":"Go","stars":2836,"topics":["protobuf","documentation-tool","protoc","hacktoberfest","hacktoberfest2021","golang","go"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"protoc-gen-doc [![CI Status][ci-svg]][ci-url] [![codecov][codecov-svg]][codecov-url] [![GoDoc][godoc-svg]][godoc-url] [![Go Report Card][goreport-svg]][goreport-url] This is a documentation generator plugin for the Google Protocol Buffers compiler ( protoc ). The plugin can generate HTML, JSON, DocBook, and Markdown documentation from comments in your .proto files. It supports proto2 and proto3, and can handle having both in the same context (see examples for proof). Installation There is a Docker image available ( docker pull pseudomuto/protoc-gen-doc ) that has everything you need to generate documentation from your protos. If you'd like to install this locally, you can go get it. go get --tool github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest Alternatively, you can download a pre-built release for your platform from the [releases][] page. Finally, this plugin is also available on Maven Central. For details about how to use it, check out the gradle example. Invoking the Plugin The plugin is invoked by passing the --doc out , and --doc opt options to the protoc compiler. The option has the following format: --doc opt= , [,default source relative] The format may be one of the built-in ones ( docbook , html , markdown or json ) or the name of a file containing a custom [Go template][gotemplate]. If the source relative flag is specified, the output file is written in the same relative directory as the input file. Using the Docker Image (Recommended) The docker imag","default_branch":null,"files":null,"tree":[],"storefront":"/r/pseudomuto","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pseudomuto/protoc-gen-doc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}