pseudomuto/protoc-gen-doc

Health v2 · maintenance only

Adoption not part of the score

2836 stars · 491 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A protoc plugin that generates documentation (HTML, JSON, DocBook, Markdown) from comments in Protocol Buffers .proto files. It supports proto2 and proto3 and can be run via Docker, Go install, pre-built binaries, or Maven Central.

Use cases

• generate documentation from proto files
• document protobuf APIs as markdown
• produce HTML docs for gRPC services
• convert proto comments into JSON reference docs
• automate protobuf docs in CI with Docker
• create custom doc output with Go templates

When to choose

• your API schemas are defined in .proto files and you want docs generated from comments
• you need multiple output formats (HTML, Markdown, JSON, DocBook) from the same source
• you want a containerized, CI-friendly documentation step for protos

When to avoid

• your API is defined in OpenAPI/Swagger rather than protobuf
• you need docs for non-protobuf code
• you want live, interactive API documentation rather than static reference docs

Facets

plugin · maturity active

documentation api-documentation parser developer-tools documentation apis cli cross-platform go protobuf protoc-plugin grpc code-generation markdown html docker

Member repositories

For agents

markdown · JSON · MCP: product_card(name="pseudomuto/protoc-gen-doc")