solidity-docgen
Advanced tools
solidity-docgenDocumentation generator for smart contract libraries. Use the inline documentation in your Solidity code for generating websites or any sort of document.
The output is completely customizable through Handlebars templates that provide easy access to all the metadata of your smart contract.
Note: Detailed usage information is not available yet. Please be patient!
npm install solidity-docgen
solidity-docgen takes as input a directory of contracts and README
documents. This directory is specified using the --input/-i flag,
defaulting to ./contracts. It produces a set of files that it will place in
the output directory specified by --output/-o, defaulting to ./docs.
solidity-docgen [ -i <input-dir> ] [ -o <output-dir> ] [ -t <templates-dir> ]
0.5.6
--solc-module option.The built in compiler remains solc 0.6, but users who want to use the newer
compiler version can do so by installing the desired solc version and using the
flag --solc-module. Here's an example using npm aliases:
npm install -D solc-0.7@npm:solc@^0.7.0
npx solidity-docgen --solc-module solc-0.7
FAQs
Documentation generator for Solidity smart contracts.
The npm package solidity-docgen receives a total of 7,174 weekly downloads. As such, solidity-docgen popularity was classified as popular.
We found that solidity-docgen demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.