Skip to content

Generate documentation in multiple formats from Ethereum smart contracts

Notifications You must be signed in to change notification settings

samatechtw/eth-docgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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>

About

Generate documentation in multiple formats from Ethereum smart contracts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published