{"bin":{"solidity-docgen":"dist/cli.js"},"dist":{"shasum":"09d268f045d3a39df33af4abec5ea919163c11c4","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.4.1-beta.0.tgz","fileCount":38,"integrity":"sha512-jrFix2B/a9BlHknwdiwc3eWarAllcruCeWzD9BiMy9hrs/Nsvez3U3qZkZ2+CzFe/LPoUKQXDIvYHzI2wMdhUw==","signatures":[{"sig":"MEUCIQCEuD7pz4wEs+R6kc+EQd3tfuU2UXSC6Xd9HiQgdO0pZQIgHOJLfXZUwQsHFfpHXEhB6uJTGNWbseQA8MwRJWpi6fU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":277324,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJedTTpCRA9TVsSAnZWagAAgekP/R1OepgBJT3kI/8dQ4Jj\nCg77jsRy6ZgEB93M6IFRnclD1eDAxAEhuYoZzNmif8jmc5hFlLhnCGCBIQBy\n5GqnJWMrNyM99AyTPTKg7+ncUl3ghJ0cbl9fkKbFw7wWNYMw3bT3IWNIhZ4J\n0Sy1QGC8EhvhmdOsDH6x4upz3goBMv2OUEMk3QUnDRreTDKoNsgeWTVoi6wb\n1xj+qAJtut/dFwZz9gtzVh9po/HIkhcQFrjH7H64UHKAufKXesJ1YzCxbiYj\nbM3EOoL1I0k1CMB04DMOJC2oAibbKc2Oa9JDACbgjnRHp91GScj7JcAdN5u9\nPEv/RkZhogjN5UAUO7IZrcL0V/HhsWNErw9FQOEwMSAU7YDScHx4wqmMBhDn\nfgvxnTCYk3gMgBEn5GNGRTuN5Okc/6Zb5TCc4YRtzXjpnnRdABk6cm4XIvQ8\n2EbQc2FGLkKBfBhC8G2xnSIrJ8bcuva8NYp89UMmdh2Rs+P00FBFbka3PKVP\npR3zKn2dWqpqfnLbbRLKIC+SkEKOLvwTX0E+lXQKG8NajpnfX9o9D4XeiVit\nrev3+aPjjLijDh6Qkw5NomfsV/a/V9oNC4URUl5k6NYL05Wu4vK1kIQryhYN\nYn0M3RGIMEdQGdwv6yJ1nKjKdAfGXUi9my5pIcSd1zslHW1KtoqwjqkmxeGW\nCUkS\r\n=O+fc\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":"07af636a3e48816080bc80261ed9edce692009a1","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.1-beta.0_1584739561294_0.001121563832415795","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.4.1-beta.0","version":"0.4.1-beta.0"}