https://github.com/go-kiss/protoc-gen-markdown
markdown doc generator for protobuf
https://github.com/go-kiss/protoc-gen-markdown
grpc markdown protobuf twirp
Last synced: 26 days ago
JSON representation
markdown doc generator for protobuf
- Host: GitHub
- URL: https://github.com/go-kiss/protoc-gen-markdown
- Owner: go-kiss
- License: mit
- Created: 2018-12-16T08:15:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T21:28:38.000Z (about 1 year ago)
- Last Synced: 2025-03-24T16:36:04.092Z (about 1 month ago)
- Topics: grpc, markdown, protobuf, twirp
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 66
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# protoc-gen-markdown
## install
```bash
go install github.com/go-kiss/protoc-gen-markdown
```
## generate markdown
```bash
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](hello.md) to see the result.
## doc
I have write a [Chinese article](https://taoshu.in/go/create-protoc-plugin.html) to introduce how it works.