Skip to content
This repository was archived by the owner on Apr 29, 2024. It is now read-only.

vegaprotocol/simple-abi-docgen

Repository files navigation

Simple ABI docgen

Generates a basic Markdown overview from a given ABI file.

It's pretty basic.

Running it

The simplest way to run it is with npx:

npx @vegaprotocol/simple-abi-docgen contract.json Title > contract.md

But if you want to clone it and run the script, you can also do it this way:

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.

About

Generates markdown from an abi.json

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •