Solidity document

For generating solidity contract documents, Realbits uses solidity-docgen package which was built by OpenZeppelin. GitHub Page and Jekyll are used for the website.

The jekyll-theme-gitbook theme for Jekyll is suitable for programming-related document sites. Realbits uses Jekyll to power its GitHub Page.

Solidity-docgen and Jekyll use the docgen function. A bug was found when generating the document, so we patched some code in the package to address the issue. In addition, we added some headers to the document to connect Solidity Docgen and Jekyll.

Patched code for solidity document
Patched code for solidity document

After some programming and patching, we can deliver a solidity document to Jekyll. Happy programming.

Subscribe to realbits-lab
Receive the latest updates directly to your inbox.
Mint this entry as an NFT to add it to your collection.
Verification
This entry has been permanently stored onchain and signed by its creator.