{"repo":"dl-solarity/hardhat-markup","free":true,"listed":false,"github":"https://github.com/dl-solarity/hardhat-markup","clone":"git clone https://github.com/dl-solarity/hardhat-markup.git","description":"Hardhat plugin to generate customizable smart contracts documentation","language":"TypeScript","stars":21,"topics":["documentation","hardhat","hardhat-plugin","markdown","solarity"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Hardhat Markup Hardhat 3 plugin to generate customizable smart contracts documentation. What This plugin generates markdown documentation of the contracts present in the project. Leveraging the natspec and solc capabilities, it is able to output beautiful uniswap-like .md files. Installation In your hardhat.config.ts , import the plugin and add it to the plugins array: Tasks The documentation generation can be run either with built-in compile or the provided markup task. To view the available options, run these help commands: Environment extensions This plugin does not extend the environment. Usage The npx hardhat markup command will compile and generate documentation for all the contracts used in the project into the default folder. Clean old artifacts via npx hardhat clean command. Configuration The default configuration looks as follows. You may customize all fields in your hardhat config file. - outdir : The directory where to store the generated documentation - onlyFiles : If specified, documentation will be generated only for matching sources, other will be ignored - skipFiles : Documentation will not be generated for any matching sources, also if those match onlyFiles - noCompile : Skips project recompilation before the documentation generation - verbose : Detailed logging on generation Compilation and build profiles When invoked, markup compiles the project (unless noCompile is set) using the production build profile and ensures userdoc and devdoc are included in the ","default_branch":null,"files":null,"tree":[],"storefront":"/r/dl-solarity","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/dl-solarity/hardhat-markup/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."}