protoc-gen-doc ☆
« Back to VersTracker
Description:
Documentation generator plugin for Google Protocol Buffers
Type: Formula  |  Tracked Since: Dec 28, 2025
Links: Homepage  |  formulae.brew.sh
Category: Developer tools
Tags: protobuf documentation grpc api generator
Install: brew install protoc-gen-doc
About:
protoc-gen-doc is a plugin for the Google Protocol Buffers compiler (protoc) that generates documentation from .proto files. It parses protocol buffer definitions and outputs human-readable formats like HTML, Markdown, or JSON. This tool streamlines API documentation by keeping it in sync with the source schema.
Key Features:
  • Supports multiple output formats (HTML, Markdown, JSON)
  • Extracts comments from .proto files for rich documentation
  • Generates API reference docs from protocol buffer definitions
  • Highly customizable templates
Use Cases:
  • Generating API documentation for gRPC services
  • Creating reference guides for data models defined in protobuf
  • Automating documentation builds in CI/CD pipelines
Alternatives:
  • protoc-gen-grpc-web – Generates TypeScript/JavaScript client code for gRPC-Web, not documentation
  • protoc-gen-openapiv2 – Generates OpenAPI (Swagger) specs instead of human-readable docs
Version History
Detected Version Rev Change Commit
Sep 15, 2025 7:34am 0 VERSION_BUMP 36785eb6
« Back to VersTracker  |  Browse Packages  |  About