How do I convert Natspec into something that a human can easily read?
Eg: HTML, Markdown, .PDF
Add a comment |
3 Answers
This appears to generate HTML documentation directly from your natspec'd code:
- Unfortunately this library is no longer maintained and support for the latest version of Solidity is not present.Cliff Hall– Cliff Hall2019-11-11 17:09:29 +00:00Commented Nov 11, 2019 at 17:09
As per the User Documentation on the Natspec page, the output is just a JSON blob.
You could feed this JSON output into a conversion tool, e.g.:
- A website such as https://codebeautify.org/json-to-html-converter;
- A command line tool - something like
jqwould probably work; - A package for your language of choice, e.g.
json2htmlfor Python.
I have released a plugin for Hardhat which generates a Vue static site from NatSpec comments: https://github.com/ItsNickBarry/hardhat-docgen
