/solidoc

Solidity Documentation Generator

Primary LanguageC#Apache License 2.0Apache-2.0

Moved to Node

This project is now rewritten in JavaScript.

https://github.com/CYBRToken/solidoc

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: