GithubHelp home page GithubHelp logo

isabella232 / solidity-docgen Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pooltogether/solidity-docgen

0.0 0.0 0.0 2.14 MB

Documentation generator for Solidity projects

License: MIT License

JavaScript 5.95% HTML 2.32% TypeScript 91.74%

solidity-docgen's Introduction

solidity-docgen

Documentation generator for smart contract libraries.

solidity-docgen allows you to document your code inline using NatSpec comments (a format similar to Javadoc and JSDoc) and then produce a website to publish the documentation.

Built with ❤️ by OpenZeppelin.

Usage

Note: Detailed usage information is not available yet. Please be patient!

npm install solidity-docgen

solidity-docgen takes as input a directory of contracts and README documents. This directory is specified using the --input/-i flag, defaulting to ./contracts. It produces a set of files that it will place in the output directory specified by --output/-o, defaulting to ./docs.

solidity-docgen [ -i <input-dir> ] [ -o <output-dir> ] [ -t <templates-dir> ]

solidity-docgen's People

Contributors

frangio avatar ealmansi avatar dependabot-preview[bot] avatar spalladino avatar dependabot[bot] avatar barakman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.