https://github.com/scaleablewebworks/grpcdoc
cli to generate comprehensive html documentation for grpc/protobuf
https://github.com/scaleablewebworks/grpcdoc
documentation golang grpc protobuf
Last synced: 6 months ago
JSON representation
cli to generate comprehensive html documentation for grpc/protobuf
- Host: GitHub
- URL: https://github.com/scaleablewebworks/grpcdoc
- Owner: ScaleableWebWorks
- License: mit
- Created: 2023-11-04T17:24:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-08T21:21:03.000Z (over 2 years ago)
- Last Synced: 2025-10-13T05:16:31.785Z (6 months ago)
- Topics: documentation, golang, grpc, protobuf
- Language: Go
- Homepage:
- Size: 2.56 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grpcdoc
> Create comprehensive html documentation from your grpc/protobuf files.
`grpcdoc` is a command line tool written in golang which takes grpc/protobuf files and generates a comprehensive html documentation for it.
## Installation
### Using Homebrew
```sh
brew tap ScaleableWebWorks/grpcdoc
brew install grpcdoc
````
### Manual installation
1. Go to [releases](https://github.com/ScaleableWebWorks/grpcdoc/releases)
2. Download the latest version for your operating system
3. Unzip the file
4. Move the binary to a location in your path
5. Run `grpcdoc` in your terminal
## Usage example
__Create a documentation for a single file__
```sh
grpcdoc -out doc.html ./path/to/your/file.proto
```
__Create a documentation for multiple files__
```sh
grpcdoc -out doc.html ./path/to/your/file1.proto ./path/to/your/file2.proto
```
__Read all .proto files from a directory__
```sh
grpcdoc -out doc.html ./path/to/your/protos
```
__Create a documentation for multiple files and include a custom css file__
```sh
grpcdoc -out doc.html -style custom.css ./path/to/your/file1.proto
```
__Read proto file from stdin__
```sh
cat ../examples/example.proto | grpcdoc > doc.html
```
__Generate and serve documentation on localhost:8000__
```sh
grpcdoc -http=:8000 ./path/to/your/file.proto
```
_For more examples and usage, please refer to the [Wiki][wiki]._
## Development setup
To start development you need to have [golang](https://go.dev/dl/) installed on your system.
```sh
git clone https://github.com/ScaleableWebWorks/grpcdoc.git
cd grpcdoc
go get
go build
```
## Release History
* 0.0.1
* Initial version Work in progress
## Meta
Marco Rico – [@mricog](https://twitter.com/mricog) – marco@scaleablewebworks.com
Distributed under the MIT license. See ``LICENSE`` for more information.
[https://github.com/ScaleableWebWorks](https://github.com/ScaleableWebWorks)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
[wiki]: https://github.com/ScaleableWebWorks/grpcdoc/wiki