How do I convert Natspec into something that a human can easily read?

Eg: HTML, Markdown, .PDF


This appears to generate HTML documentation directly from your natspec'd code:


| improve this answer | |
  • Unfortunately this library is no longer maintained and support for the latest version of Solidity is not present. – Cliff Hall Nov 11 '19 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.:

| improve this answer | |

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.