tendermint/rpc/core/README.md

21 lines
798 B
Markdown
Raw Normal View History

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
documentation. For generating markdown use:
2017-06-01 19:01:48 +03:00
```shell
go get github.com/davecheney/godoc2md
2017-06-01 19:01:48 +03:00
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$'
```
2018-05-14 16:01:49 +04:00
For more information see the [CI script for building the Slate docs](/scripts/slate.sh)
2018-05-14 16:01:49 +04:00
## Pagination
Requests that return multiple items will be paginated to 30 items by default.
You can specify further pages with the ?page parameter. You can also set a
custom page size up to 100 with the ?per_page parameter.