2017-06-01 19:01:48 +03:00
|
|
|
# Tendermint RPC
|
|
|
|
|
|
|
|
|
|
## Generate markdown for [Slate](https://github.com/tendermint/slate)
|
|
|
|
|
|
2017-08-16 15:18:55 -04:00
|
|
|
We are using [Slate](https://github.com/tendermint/slate) to power our RPC
|
2017-06-01 19:01:48 +03:00
|
|
|
documentation. If you are changing a comment, make sure to copy the resulting
|
|
|
|
|
changes to the slate repo and make a PR
|
|
|
|
|
[there](https://github.com/tendermint/slate) as well. For generating markdown
|
|
|
|
|
use:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
go get github.com/melekes/godoc2md
|
|
|
|
|
|
|
|
|
|
godoc2md -template rpc/core/doc_template.txt github.com/tendermint/tendermint/rpc/core | grep -v -e "pipe.go" -e "routes.go" -e "dev.go" | sed 's$/src/target$https://github.com/tendermint/tendermint/tree/master/rpc/core$'
|
|
|
|
|
```
|
