Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including solidoc with all npm packages installed. Try it out:

var solidoc = require("solidoc")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

solidoc v1.0.5

Solidity Documentation Generator

Solidoc: Documentation Generator for Solidity

This command-line utility creates markdown-based documentation for your Solidity project(s) for the following platforms:

  • Ethereum
  • Ethereum Classic
  • Tron
  • Qtum
  • Wanchain
  • Aeternity
  • Counterparty
  • Rootstock
  • Ubiq
  • Monax

Getting Started

sudo npm install solidoc -g

CLI Arguments

  1. Path to truffle project (or similar) root.
  2. Path to generate documentation to.
  3. Do not recompile. Optional, default: false.
  4. Language. Optional, default: en.

How to Use Solidoc?

On your project root, run the following command.

solidoc ./ ./docs true

This will generate documentation to the docs directory.

Or edit package.json

  "scripts": {
    "docgen": "solidoc ./ ./docs"

and run

npm run docgen


Do not use recompilation (third argument) if you are using this on a non truffle project.

Configuration File

Alternatively, you can create solidoc.json configuration file in your project root.

  "pathToRoot": "./",
  "outputPath": "./docs",
  "noCompilation": true,
  "compiler": "truffle compile",
  "language": "en"

and then call solidoc instead of passing any command line argument.


If you wish to change bits and pieces of the documentation generated, place solidoc templates on the following directory:


Solidoc Templates

You can also override language literals by copying and editing i18n files on the following path:


Before You Try


RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free