⚠️ EthDoc is still a work in progress and has not yet had a V1 release ⚠️

Create beautiful automatically generated documentation for Ethereum smart contracts.

This repository contains the source code for the CLI portion of EthDoc. An Open Source developer tool that generates documentation for Smart Contracts using Ethereum Natural Specification Format.

Getting Started

The easiest way to get started with EthDoc is through the CLI. Follow the instructions below to get started!

1. Install NPM Package

$ npm install ethdoc --save

2. Initialize Ethdoc within your Ethereum project

$ ethdoc init

This may take a few minutes. You only have to run this command the first time you integrate EthDoc into an Ethereum Project.

3. Generate documentation

$ ethdoc generate contracts/ -s

Pass the name of the folder where your contracts are. In the example above, we chose contracts/. But if your contracts reside in some otherDirectory/ you can just pass it in as an argument. Here's an example below:

$ ethdoc generate otherDirectory/ -s

4. Check out your documentation

🎉 Navigate to http://localhost:3000 to check out your docs 🎉

Development

The EthDoc CLI was built using Oclif which is a framework for building CLIs in Node made by the awesome people over at Heroku!

1. Install Dependencies

$ npm install

2. Link Package

$ npm link

This command makes it so that the ethdoc command runs the program located in current directory vs. your globally installed version. If you're done developing and would like to use the globally installed version, just run npm unlink.

License

MIT