@vegaprotocol/openrpc-md

openrpc-md

A very simple OpenRPC to Markdown documentation generator for very simple OpenRPC specs

Usage

Specify an OpenRPC json file when

npx @vegaprotocol/openrpc-md ./sample/openrpc.json

Example

• openrpc.json produces output.md

Alternatives

A much richer set of tools is available from Open RPC, specifically:

• open-rpc/generator can generate Gatsby docs
• open-rpc/playground creates an interactive UI for reading about & executing queries
• openrpc/docs-react is a React component to render just the documentation

But if none of those work for yoru configuration and all you want is Markdown, then you might be in the right place.

LICENSE

MIT