@vegaprotocol/simple-abi-docgen

Simple ABI docgen

Generates a basic Markdown overview from a given ABI file.

It's pretty basic.

Running it

node index.js ./contract.json My Contract Title

Sample output

See the ERC20 example for the output, run against OpenZeppelin IERC20.sol.

In the wild

Feel free to add your project here if you're using simple-abi-docgen:

Alternatives

You probably really want solidity-docgen and to use NatSpec.