README
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
- Path to truffle project (or similar) root.
- Path to generate documentation to.
- Do not recompile. Optional, default: false.
- 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/
You can also override language literals by copying and editing i18n
files on the following path:
./.solidoc/i18n/