@rocketh/doc
v0.19.34
Published
Generate documentation from EVM contract deployments and NatSpec comments.
Maintainers
Readme
@rocketh/doc
rocketh-doc: reference documentation of an environment's deployments, generated from their ABIs and NatSpec through Handlebars templates (bundled, or your own), or as a data model you render yourself.
Installation
pnpm add -D @rocketh/doc
# or
npm install --save-dev @rocketh/doc@rocketh/node is a peer dependency.
Example
# leave out the records a proxy writes next to the contract
npx rocketh-doc -e sepolia -o ./docs/contracts --except-suffix _Implementation,_ProxyDocumentation
The whole documentation is at rocketh.dev, the hardhat-deploy section at rocketh.dev/hardhat-deploy.
