{"repo":"GoogleCloudPlatform/proto-gen-md-diagrams","free":true,"listed":false,"github":"https://github.com/GoogleCloudPlatform/proto-gen-md-diagrams","clone":"git clone https://github.com/GoogleCloudPlatform/proto-gen-md-diagrams.git","description":"A utility for generating Markdown documentation for Protocol Buffers that include Mermaid UML Diagrams.","language":"Go","stars":78,"topics":["documentation","markdown","protobuf","protocol-buffers"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Proto Gen MD Diagrams This utility package is a compiled Go program that reads a protobuf source directory and generates Mermaid Diagrams in .md files in each directory, or the output directory with the given tree structure. NOTE: Only Proto 3 syntax is supported. This utility was created to ease documentation generation of complex Protobuf libraries to visualize models and services described in a Protocol buffers. If you find this useful, awesome! If you find a bug, please contribute a patch, or open a bug. Please follow the Contributing guidelines. Test Input and Output Build and test Using Native Go Using Bazel Since Bazel is CI/CD workflow program it compiles for all targets. Input File Output File ------------------------------------------------------------------------ --------------------------------------------------------------------------- Location Protobuf Location Markdown Location Service Protobuf Location Service Markdown Building Go Lang Use and Options Quick Example Protobuf Input Supported Output Formats proto-gen-md-diagrams supports two markdown output formats, both of which include Mermaid class diagrams when visualization is enabled ( -v=true , default): 1. Default Mode (HTML-Enhanced Markdown) : Uses styled HTML elements ( , ) for metadata styling and clean table displays. 2. Pure Markdown Mode ( -md ) : Produces strict GitHub-Flavored Markdown using backtick code formatting ( field ) and bold text without HTML tags. Output Mermaid Diagram The generator e","default_branch":null,"files":null,"tree":[],"storefront":"/r/GoogleCloudPlatform","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/GoogleCloudPlatform/proto-gen-md-diagrams/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."}