{"bin":{"solidity-docgen":"./dist/cli.js"},"dist":{"shasum":"a38aa40bd8e9e5680c57e55edaaa6bc10c861d23","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.3.7-beta.1.tgz","fileCount":34,"integrity":"sha512-77UlC7IruHemWTeWrzktewzidM2dERNrDyOKREYbfmRnEsy5m4ccSF4yEMG2hB9AwobHgIZBUOg6r76LVM5FrA==","signatures":[{"sig":"MEYCIQCoz4kSJKz+lhtI2PnAHnjtUMmBbJugz0GbFkG+xD6aIAIhALDC1X2pEFcrl/nFDcrHqqXDL8pVMGk8W3+PEltrEelV","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":253319,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduHZeCRA9TVsSAnZWagAAgqMP/Rnk/o6mBWHXFzV6k80U\nkM9ty4gfkO7kIHwgEpUsyO3ibvlbOK/zJ/ETBEXIIzg2bbsHzk3pse2HBjOu\nfCR4Fxl7wlKYUtoGT94+z9scx603SQXZqu6eR5fFKnYH2tUKBxQDVg2mTxWK\nReY/sinWUEmE0xrtYGxt583mSExo504BApRP41iGoTGBgJjMvMzka5tWoyDF\nA9raLgl+AgvNK/o3Cz9fkAVF+bzL0RXxvjGh2QTsTVcXzGUhQDUUaGlz/Q60\nzSD2kbLJhHkCshJkSxySwz7d3D4eZh4M+HZCfbNzj89DlbG4+LD+B/9F6KcR\nmKtkA1RQVgISQggkyYf4LmAvSRRcBk9D0JL2t+S6CFB4NxHVU+DFchsGKzcp\nIRqVtagaCpupwU5wqItDhDvduTuqzEx8LwgXP7bzwf+4BgfY0ItnHgSIN5Dj\n06eJ4b02NW7GdgHVzCMAYhynBmxEkQNMA8ZNW7nRlHVflXxrkXoA2XmOkqlB\nAd9gtRILHxHHUjxhcK6UG/7G7HqifJFxSEKRBCpzGtkq4YbQHZTP8s3uRp60\nbTMBKD5V/OhRNEchKTp1l8vGfMn7EyyI7peRQtTnvcu/CX0OtYp06Q62/gHb\nS51LuNL5R9JK0yoKbf/qWSsa3jTh0h/2A8Y4+OyAfkXBGP2y1jdUCjgBuHN6\n/xey\r\n=jdLS\r\n-----END PGP SIGNATURE-----\r\n"},"name":"solidity-docgen","readme":"# `solidity-docgen`\n\n**Documentation generator for smart contract libraries.**\n\n`solidity-docgen` allows you to document your code inline using [NatSpec]\ncomments (a format similar to Javadoc and JSDoc) and then produce a website\nto publish the documentation.\n\nBuilt with :heart: by OpenZeppelin.\n\n## Usage\n\n> **Note:** Detailed usage information is not available yet. Please be patient!\n\n```sh\nnpm install solidity-docgen\n```\n\n`solidity-docgen` takes as input a directory of contracts and `README`\ndocuments. This directory is specified using the `--input`/`-i` flag,\ndefaulting to `./contracts`. It produces a set of files that it will place in\nthe output directory specified by `--output`/`-o`, defaulting to `./docs`.\n\n```\nsolidity-docgen [ -i <input-dir> ] [ -o <output-dir> ] [ -t <templates-dir> ]\n```\n\n[NatSpec]: https://solidity.readthedocs.io/en/develop/natspec-format.html\n","gitHead":"751d1fd8fdc3f1fb3e185621e8cdfa197b7624f4","license":"MIT","scripts":{"test":"tsc && ava","build":"tsc","prepare":"npm run build","coverage":"nyc --reporter=lcov npm test","test:watch":"concurrently -krs first -n ava,tsc 'ava --watch' 'tsc --watch --preserveWatchOutput'","build:watch":"tsc --watch"},"_npmUser":{"name":"frangio","email":"frangio.1@gmail.com"},"keywords":["solidity","api","documentation","automatic","generator"],"_npmVersion":"6.7.0","description":"Solidity API documentation automatic generator.","directories":{},"maintainers":[{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"11.15.0","dependencies":{"solc":"^0.5.12","json5":"^2.1.0","globby":"^10.0.1","lodash":"^4.17.15","semver":"^6.3.0","fs-extra":"^8.1.0","minimatch":"^3.0.4","handlebars":"^4.4.0","micromatch":"^4.0.2","@oclif/config":"^1.13.3","@oclif/errors":"^1.2.2","@oclif/command":"^1.5.19","@oclif/plugin-help":"^2.2.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^2.4.0","nyc":"^14.1.1","codecov":"^3.6.1","code-style":"github:OpenZeppelin/code-style","typescript":"^3.6.3","@types/node":"^12.7.9","@types/json5":"0.0.30","concurrently":"^5.0.0","@types/lodash":"^4.14.141","@types/semver":"^6.0.2","@types/fs-extra":"^8.0.0","@types/minimatch":"^3.0.3","@types/micromatch":"^3.1.0","@istanbuljs/nyc-config-typescript":"^0.1.3"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.3.7-beta.1_1572370014080_0.2632498782640784","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.3.7-beta.1","version":"0.3.7-beta.1"}