@jplsaez/solidoc

1.1.0 • Public • Published

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

npm install @jplsaez/solidoc

How to Use Solidoc?

Create solidoc.json configuration file in your project root.

{
  "pathToRoot": "./",
  "outputPath": "./docs",
  "noCompilation": false,
  "compiler": "truffle compile",
  "language": "en",  
  "includedContracts": "ContractName1, ContractName2"	
}

and then call

solidoc

This will generate documentation to the docs directory.

Another option: edit package.json

  "scripts": {
    "docgen": "solidoc"
  }

and run

npm run docgen

Note

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

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/

Package Sidebar

Install

npm i @jplsaez/solidoc

Weekly Downloads

2

Version

1.1.0

License

Apache-2.0

Unpacked Size

60.8 kB

Total Files

46

Last publish

Collaborators

  • jplsaez