foundry-docgen

Contract doc generator

Generates markdown docs for Foundry projects from existing NatSpec comments in contracts

GitHub
50 stars
2 watching
1 forks
Language: JavaScript
last commit: over 2 years ago
Linked from 1 awesome list


Backlinks from these awesome lists:

Related projects:

Repository Description Stars
zeframlou/foundry-template A template project for building and deploying smart contracts using Foundry framework 155
zeframlou/foundry-canary A repository for experimenting with and reproducing issues in the Foundry framework for Ethereum development 46
mermade/reslate A proof-of-concept tool for generating static documentation for APIs using Slate v3 and Eleventy 145
foundry-rs/forge-template A starter project for building Smart Contract projects with Foundry's Forge framework. 386
zeioth/dooku.nvim Generates HTML documentation from code comments 41
openzeppelin/solidity-docgen Extracts and formats documentation from Solidity source code 452
senchalabs/jsduck Generates documentation for JavaScript code using Markdown and infers information from the code itself. 1,503
tj/dox Generates documentation for JavaScript code in JSON format 2,156
openzeppelin/contracts-wizard Generates smart contract code from pre-defined components 251
fransbouma/docnet A tool for generating user documentation from markdown files using a static site generator approach 250
dineshsonachalam/repo-using-markdown-autodocs Demonstrates markdown-autodocs functionality with examples of auto-generated documentation 7
ralt/docgenerator Automates the creation of documentation from markdown files 5
freeman-lab/minidocs Generates a minimalist documentation site from markdown files and a table of contents 137
lun-4/zig-docsearch Searches and generates HTML documentation from Zig standard library doc comments 0
naturaldocs/naturaldocs Automatically generates high-quality HTML documentation from code written in multiple programming languages. 203