{"bin":{"solidity-docgen":"./dist/cli.js"},"dist":{"shasum":"a1acbcff2e5de919948563d837ad5098063bbef7","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.2.0-alpha.0.tgz","fileCount":20,"integrity":"sha512-Us3v9QoXI6IP4iwdUsjPlUB2w9Qd1rtUa4djDkGyKIxZxJxVkAnFxuKXIAmFl6aRGz/eKUsOZdOT2KEvVlBU2w==","signatures":[{"sig":"MEUCIQDIpSzYuEggcbDsfa3uSEqLQvIA1VSSpVEpdelbPz5xtwIgfFQJb9HrlhIOymg4xZk4nsntsNcX0Ey6Z8EAylKAhbM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37782,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcvysmCRA9TVsSAnZWagAAKO8QAI9U7aJxO+oh+0af1Dk1\n9BYzD+i3bIGqYXtj7iRIqbNnXqQBvFPaHVjrHmdhoKsnXnZsqKOfpcvKJDct\nGIQonqSChMVcghxf8EoZ4meqtJ43fOJqFR7cPN7p4aXhvWD7mi8PIOZn6KV6\naP0rwNkB19ZV4MnPjMzI+opUY1ImkdrFxHnluXcB+E1Gf6WUsQX1bibPX/us\nu2nPDKKi6diRqbzbCADkFK1V3G1dR/+V3XQkHJFvoJheV5LnvGUOMsCQ36oi\nhDLO+fhGx6rF6TgG3IwPFdZd0SoBQuOFCVE6U+gSkX3I1ZdikeHUZ7EQy3qK\n5bXNkL0Lk8kRbNzlbSNsvCzrscgkYv8DDI0B12GYe2e1czvSIbM5pSwOhPQC\n33diHniFkalhibVaMVPsKF7gblA6/kbZUkItKcgDeNC+s3F/VDi5Z8MyASi4\nDrb1kg4UqMN3zLclUMYxaUsTgf5KcVh+JnXv1oaupMyYkgNHeSzPG+IJJu+b\neI2p6KUjMaVaaAkEZhWrpP8uzh//M0ji/z+XnxbHOdZqoYGYHvudcHZze/hI\nRCF4vj4TSmwAgWrhlpvuJPWV16HJ3l5hg06E0mMKi43Dbbx7ouDKUvJVQZjZ\nUc2SD5pdqUOvlMHhB0hnUtcKY+sj3xo0W3CQR3sZoTcT4smYG3nNcv82BGYp\nKEs6\r\n=a566\r\n-----END PGP SIGNATURE-----\r\n"},"name":"solidity-docgen","author":{"name":"spalladino@gmail.com"},"readme":"# `solidity-docgen` (WIP)\n\n**Documentation generator for libraries of smart contracts.**\n\n`solidity-docgen` combines inline documentation with long form documents to\ngenerate documentation pages that can be easily made into a static site.\n\nUsed to generate the documentation for OpenZeppelin.\n\n## Install\n\n```sh\nnpm install solidity-docgen\n```\n\n## Usage\n\n1. Document your source code in inline comments using `@dev` tags in the [NatSpec] format.\n2. Write longer form documentation in a README.md file next to your smart contracts. (Optional)\n3. Run `npx solidity-docgen` at the root of your project to generate documentation pages in the `docs/` directory.\n4. Serve the documentation using a static site generator.\n\n[NatSpec]: https://solidity.readthedocs.io/en/develop/natspec-format.html\n","gitHead":"8108281826cad7a7e9f75314620b3581581266e8","license":"MIT","scripts":{"test":"jest","build":"babel --out-dir dist src","prepare":"npm run build","test:watch":"jest --watch"},"_npmUser":{"name":"frangio","email":"frangio.1@gmail.com"},"keywords":["solidity","api","documentation","automatic","generator"],"_npmVersion":"6.9.0","description":"Solidity API documentation automatic generator.","directories":{},"maintainers":[{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"11.14.0","contributors":[{"url":"http://ealmansi.github.io/","name":"Emilio Almansi","email":"ealmansi@gmail.com"}],"dependencies":{"glob":"^7.1.3","solc":"^0.5.4","react":"^16.8.3","lodash":"^4.17.11","js-yaml":"^3.12.2","commander":"^2.14.1","react-dom":"^16.8.3"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.1.0","@babel/cli":"^7.2.3","@babel/core":"^7.2.2","@babel/register":"^7.0.0","@babel/preset-env":"^7.3.1","@babel/preset-react":"^7.0.0","react-test-renderer":"^16.8.1","@babel/plugin-proposal-object-rest-spread":"^7.4.0"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.2.0-alpha.0_1556032292647_0.6060027577808325","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.2.0-alpha.0","version":"0.2.0-alpha.0"}