Skip to content

Generate simplistic markdown overview from an openrpc doc

License

Notifications You must be signed in to change notification settings

vegaprotocol/openrpc-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Alternatives

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

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

MIT