{"repo":"ItsNickBarry/hardhat-docgen","free":true,"listed":false,"github":"https://github.com/ItsNickBarry/hardhat-docgen","clone":"git clone https://github.com/ItsNickBarry/hardhat-docgen.git","description":"Automatically convert NatSpec code comments to a static documentation site 📝","language":"JavaScript","stars":47,"topics":["hardhat","natspec","documentation","devdoc","userdoc","buidler","solidity","smart-contracts","ethereum","blockchain"],"license":"MIT","category":"blockchain-web3","readme_excerpt":"Hardhat Docgen Generate a static documentation site from NatSpec comments automatically on compilation with Hardhat. Installation Usage Load plugin in Hardhat config: Add configuration under the docgen key: option description default -------------- ---------------------------------------------------------------------------------------------------------- -------------------------------------------------------------- path path to HTML export directory (relative to Hardhat root) './docgen' clear whether to delete old files in path on documentation generation false runOnCompile whether to automatically generate documentation during compilation false only Array of String matchers used to select included contracts, defaults to all contracts if length is 0 ['^contracts/'] (dependent on Hardhat paths configuration) except Array of String matchers used to exclude contracts [] The included Hardhat task may be run manually: By default, the hardhat compile task is run before generating documentation. This behavior can be disabled with the --no-compile flag: The path directory will be created if it does not exist. The clear option is set to false by default because it represents a destructive action, but should be set to true in most cases. Development Install dependencies via Yarn: Setup Husky to format code on commit:","default_branch":null,"files":null,"tree":[],"storefront":"/r/ItsNickBarry","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ItsNickBarry/hardhat-docgen/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}