{"bin":{"solidity-docgen":"dist/cli.js"},"dist":{"shasum":"e90d5ff1c0b5b4c61df36825cf7d1b555de3b488","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.4.0-beta.1.tgz","fileCount":36,"integrity":"sha512-zPjsZUrC4e0GVqXRbz2//Pd8spEllFmx4cnkGzBI+OXCxdmSBGch2+w7u3oOLeppDHhBu1iWxFFWTfmhkNKkJg==","signatures":[{"sig":"MEYCIQCf69DyfYi6Pdj4OcO9FrGOTPwWlq6XwgyYTK2516IhngIhAOx4qJcsS7JBXSa40Ehos3ktKELePsiNNx/emCSaQ61N","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":276495,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJecA0dCRA9TVsSAnZWagAA33sP/2bpyW5yeHZ3Or1cZlRK\nxe/mCdlZ+murO3Df5WQjlayFNVm+XDJ8MDAH8V5EEDH7OlUEy92MOGca0Nsn\n2b5xOyonvYaXrze8NPLAA+bUmzePtxKwQWXf0OzKAptO0Tv4VfvlfFKtLSSz\nn+OT1EeC5gb34GLkRycF0st4Hhqc1ajr6kWmrnUbKDwC/ifJIGLNcFGh3QL5\nV2Ly/cQms6b6vTJu1J9pMXlNhwpsOsc6HneC/bUO9MRfAQlLd2PbKPuEEqtA\naF7S9dav09OZaR7NyvYerH2AD3H14wj6Nxk4bL8LhfgUDqXOJ/imo2GmH0DA\noi2oddReTC6Nr1xixCYu9gy8EIXEql/W7cU7cnOHGrzV0GVtiJAcDVgiF/WY\n/dSg+gLgrtxWTD/QKAiBJbKPbydTgx8mjxYOz9LZcFeZZKSK0wfTPDe3+h0r\ntw+jn18641Iquabq4eRCjga3FJGSEa6CaJBenKGFn5D4olNnJrKrtaAreLHu\nOE0+aWzILvBP10Xu3nlne8ahNxF6LOJNyLC37+BmQ6c4ZRpAJdCu733RRwus\nFtAgLg7qVFYnidrJXDvH5hVk7eC6tYJ1Ovydv69fKcl/D87vflRz6Mq6xyED\nbuqe3EGpzC1djJPhUECX7T/3q2irVv84V1CVzyT3JnsnAs95qgx+VNnq1Ips\nWWZm\r\n=uY59\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\n### Contracts with Dependendencies\n\nDependencies don't work out of the box yet, and you have to manually set up solc remappings.\n\nFor example, for OpenZeppelin dependencies like `@openzeppelin/contracts` you would run the following command.\n\n```\nsolidity-docgen --solc-settings \"{remappings: ['@openzeppelin=$PWD/node_modules/@openzeppelin']}\"\n```\n","gitHead":"03b66238130bfaef5abdadeb04b9a3bcb14283ca","license":"MIT","scripts":{"docs":"oz-docs -c docs","test":"tsc && ava","build":"tsc","prepare":"npm run build","coverage":"nyc --reporter=lcov npm test","docs:watch":"npm run docs watch","test:watch":"fgbg 'ava --watch' 'tsc --watch'","build:watch":"tsc --watch"},"_npmUser":{"name":"frangio","email":"frangio.1@gmail.com"},"keywords":["solidity","api","documentation","automatic","generator"],"_npmVersion":"6.13.4","description":"Solidity API documentation automatic generator.","directories":{},"maintainers":[{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"12.14.1","dependencies":{"solc":"^0.6.4","json5":"^2.1.0","globby":"^11.0.0","lodash":"^4.17.15","semver":"^7.1.3","fs-extra":"^8.1.0","minimatch":"^3.0.4","handlebars":"^4.7.3","micromatch":"^4.0.2","@oclif/config":"^1.14.0","@oclif/errors":"^1.2.2","@oclif/command":"^1.5.19","@oclif/plugin-help":"^2.2.3"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.5.0","nyc":"^15.0.0","fgbg":"^0.1.4","codecov":"^3.6.5","solc-0-4":"npm:solc@^0.4.24","solc-0-5":"npm:solc@^0.5.14","code-style":"github:OpenZeppelin/code-style","typescript":"^3.8.3","@types/node":"^10.17.17","@types/json5":"0.0.30","@types/lodash":"^4.14.149","@types/semver":"^7.1.0","@types/fs-extra":"^8.1.0","@types/minimatch":"^3.0.3","@types/micromatch":"^4.0.1","openzeppelin-docs-utils":"github:OpenZeppelin/docs-utils","@istanbuljs/nyc-config-typescript":"^1.0.1"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.4.0-beta.1_1584401692584_0.3657563654842859","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.4.0-beta.1","version":"0.4.0-beta.1"}