Mastering Blockchain Programming with Solidity

Generating the markdown report

The surya mdreport (markdown report) command generates the same report as the surya describe command. The only difference is that the surya mdreport command generates the report in markdown format. The command used to generate the report takes the new report filename and the contract filename, as follows:

$ surya mdreport erc20.md contracts/token/ERC20/ERC20.sol

The preceding command will generate the report in markdown format; when viewed in the markdown viewer or on GitHub, it looks similar to the following screenshot:

The surya markdown report of ERC20.sol viewed in the markdown viewer

You can also find the ...