You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

15 lines
637 B

7 years ago
  1. # Tendermint RPC
  2. ## Generate markdown for [Slate](https://github.com/tendermint/slate)
  3. We are using [Slate](https://github.com/tendermint/slate) to power our RPC
  4. documentation. If you are changing a comment, make sure to copy the resulting
  5. changes to the slate repo and make a PR
  6. [there](https://github.com/tendermint/slate) as well. For generating markdown
  7. use:
  8. ```shell
  9. go get github.com/melekes/godoc2md
  10. 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$'
  11. ```