Solidoc--Documentation Generator for Solidity

This command-line utility creates markdown-based documentation for your Solidity projects.

Getting Started

• Clone the project. git clone https://github.com/binodnp/solidoc
• Compile the project. dotnet build
• Create a bash script to automate documentation generation as a part of your build process.

*nix

dotnet solidoc.dll <path to project> <path to generate documentation to>

Windows

solidoc.exe <path to project> <path to generate documentation to>

Examples:

• Open Source Vesting Schedule by Binod
• Virtual Rehab Token
• Virtual Rehab Private Sale