solidity-docgen
Solidity API documentation automatic generator.
Last updated a month ago by frangio .
MIT · Original npm · Tarball · package.json
$ cnpm install solidity-docgen 
SYNC missed versions from official npm registry.

solidity-docgen

Documentation generator for smart contract libraries. Use the inline documentation in your Solidity code for generating websites or any sort of document.

The output is completely customizable through Handlebars templates that provide easy access to all the metadata of your smart contract.

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> ]

Current Tags

  • 0.5.3                                ...           latest (a month ago)
  • 0.4.1-beta.0                                ...           next (2 months ago)

36 Versions

  • 0.5.3                                ...           a month ago
  • 0.5.2                                ...           a month ago
  • 0.5.1                                ...           a month ago
  • 0.5.0                                ...           a month ago
  • 0.4.1                                ...           2 months ago
  • 0.4.1-beta.0                                ...           2 months ago
  • 0.4.0                                ...           2 months ago
  • 0.4.0-beta.1                                ...           2 months ago
  • 0.4.0-beta.0                                ...           2 months ago
  • 0.3.14                                ...           4 months ago
  • 0.3.13                                ...           6 months ago
  • 0.3.12                                ...           7 months ago
  • 0.3.11                                ...           7 months ago
  • 0.3.10                                ...           7 months ago
  • 0.3.9                                ...           7 months ago
  • 0.3.8                                ...           7 months ago
  • 0.3.7                                ...           7 months ago
  • 0.3.7-beta.2                                ...           7 months ago
  • 0.3.7-beta.1                                ...           7 months ago
  • 0.3.7-beta.0                                ...           7 months ago
  • 0.3.6                                ...           7 months ago
  • 0.3.5                                ...           7 months ago
  • 0.3.4                                ...           8 months ago
  • 0.3.3                                ...           8 months ago
  • 0.3.2                                ...           8 months ago
  • 0.3.1                                ...           8 months ago
  • 0.3.0                                ...           8 months ago
  • 0.3.0-beta.4                                ...           10 months ago
  • 0.3.0-beta.3                                ...           10 months ago
  • 0.3.0-beta.2                                ...           10 months ago
  • 0.3.0-beta.1                                ...           a year ago
  • 0.3.0-beta.0                                ...           a year ago
  • 0.2.0-alpha.1                                ...           a year ago
  • 0.2.0-alpha.0                                ...           a year ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 77
Last Day 0
Last Week 1
Last Month 276
Dependencies (13)
Dev Dependencies (16)

Copyright 2014 - 2016 © taobao.org |