Solidity Documentation Generator
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
builders Fixed path resolve issues and redundant state mutability output. Oct 30, 2018
helpers
i18n
node_utils
serializers
templates
utils
.babelrc
.eslintrc.json
.gitignore
LICENSE
cli.js
generator.js Ported Solidoc from c#. Oct 24, 2018
i18n.js
package-lock.json
package.json Updated repository info. Nov 4, 2018
parser.js
readme.md
solidoc.json

readme.md

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

Note

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.

Overrides

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

./.solidoc/templates/

Solidoc Templates

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

./.solidoc/i18n/

Before You Try