iMuzz / ethdoc

📚 An Open Source documentation generation tool for Ethereum smart contracts 🎉

⚠️This tool is in alpha and has not yet been officially released. The instructions below will not work.

Automatically generate beautiful documentation for your Ethereum smart contracts.

This repository contains the source code for the frontend portion of Ethdoc. An Open Source developer tool that generates documentation for Smart Contracts using Ethereum Natural Specification Format. The project is split into two parts, the CLI and frontend (the repo you're currently on).

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

Ethdoc was built using Next.js which is a framework created by the awesome people over at Zeit!

1. Install Dependencies

$ npm install

2. Start your server

$ npm run dev

Navigate to http://localhost:3000 to see your changes. All changes are automatically reflected in the browser without having to refresh thanks to Next.js 😍

Contributors

• Faraaz Nishtar (iMuzz)
• Achal Srinivasan (achalvs)

License

MIT