{"bin":{"solidity-docgen":"dist/cli.js"},"dist":{"shasum":"2bea07ce9d76a42bdf03d44455be7e77cfa93883","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.4.0-beta.0.tgz","fileCount":36,"integrity":"sha512-BRhP99q0sOWRQKiCH0Zg8/j8vE8U63N00BTA2BMC+8D471sG23RB0GkbNkkK1an8qBlj1x38qHcVAC5aNEejxg==","signatures":[{"sig":"MEUCIQC0U9cdHvRSMtBjF1Im8tZe4qCMOcgMtrUyOkasqcSWdwIgFEn7ehWyHgn0x3JKBjAQZ02cl8EXKEwaL665jjPHKJ0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":271697,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJecAY/CRA9TVsSAnZWagAAi6gQAIjj7C40BphXfx3C2BFi\nS76BHw108UtIxne2o3cX1+IVKJ8AUQOnkXaXpFqEdItJgtqS5hs4vyRtktfi\nRoIy8fNW9KbwVJb/uF4v1dWl8uy9pEvaDPoBPIWEoiJccPGHTOuOfdbEY2qt\nZ06sTSQjJnB9dhPd0TQe3trbacXE7kg65jZlNIWANfiK2C6+GGEeug/Rjv7v\nTIQxRBl6X4Oob/4DY2lQVadcE8RKMpuetZ+5A79YJ56castiV6Bl1b8r5voO\nnnMdGg4l+oowKQuexBD+yJI5Yj8fOSMFOQE7U8j8tiYniplrU/h8tW+P0UB5\nJtsYsYrp02nbghjB6U/BWiBHaLD7Jwyggo78vn+SusFXKkF0Nvk1EuIA2w+F\nlWj7HWUbcGnxlbDSCdnFRN8HbazlPkqzeogVXGRzjxfM4zni3CFSArupQKEo\nK+l7HvB3MByehxiKp7AsqZLfhG+YrsM+ps3BVGJDks5DkkEW0GsQO1hsMCft\nidhxlI6hqBOlh66tNzRvqaJUfpKu2mEGSA1ViQTSaV6phPGJWP8xyOBb6Dm2\n/W4+j5HRykpkkU4l2pXZHmEpRSCtsJ1CRi5D2gP65PMr/k3Hxvd0rLYZ1MXQ\naqCTqd3fZYeQIHwo14gt6Y8H3MRd84AsY0aO9tYP2Hb7Cr0x/2gcKO46ydnr\nZO+4\r\n=wKfy\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":"a87f7541159166c0b5fdaca42daf1380a72836ff","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.0_1584399934876_0.43879631544136943","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.4.0-beta.0","version":"0.4.0-beta.0"}