/eth-docgen

Generate documentation in multiple formats from Ethereum smart contracts

Primary LanguageTypeScript

Solidity Documentation Generator

Generate html documentation from Ethereum smart contracts.

Usage

We recommend PNPM for reducing disk usage and speeding up installation for Javascript/Typescript projects. npm may be substituted with pnpm in the following commands:

Install

pnpm install

Run example

pnpm run example

Build library

pnpm run build

Run on local project

node dist/eth-docgen.js <folder>