{"bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"dist":{"shasum":"85fdb696552686280594c1009a2b2f129ec4dae5","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.6.0-beta.4.tgz","fileCount":134,"integrity":"sha512-MM7e9H2XGyGOkTgDNW2EPDbUniQPdJZy9esU68EgYFLqmGy+2k6fyzmGZ96C7hTkcgtTlXrAb6S1G/XmAVpOKg==","signatures":[{"sig":"MEYCIQCJ2XVaFOXwVQkgwMp3ZVy6CtJdW3FElO7mhlKpLoOEwgIhAKtb4AncS10lxdd0CRcoGBdRKm9R93SOUU1DLZ8Re3cb","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":117949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiGqN4ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoMWQ//bohj5GJ72vRLt4rI0o3AcuEnz7DkccUNUFR3oOHuyP+sPVRV\r\nx8dckUZeODSnxnn22UhVe9NbS43nP/xDlgc9FonXzNjMT47rMBE6nXNIHIm2\r\nBdV1QfZrH2RyaPkFM4DxscE0I/xIxw2OXVGYONLI+H3BO8K4aEiadx24Mfjz\r\nylUjD4BblF5e9qZ8VAs4cu0N0hSv7MjIIw4XM62B52T3/xZgcur0u81HLZGo\r\nAyLImwfzSyEsvxWvxLvt4hbik60AkeN7o6KdB3bmF50PYk7WfnFKp+NqcxPp\r\n1RXVq9M9woQsc3NYGTwFA1rluAqgUt3P/d8rIf7v4rAWPnlqRBex9zUM8/hq\r\nEVilXQQTPQEl5K9ZVjcIkgAxgVrqg2SQ8HWhUE/3tAqVQoX1e1tOW9JaaroR\r\nKymkHC4Fd7zzIvPEjRhDP8ybsQsR8/VdKk4nyM2VcVgm5QafB4+IpQPFxiHD\r\nGzDGOtuSjA5g6UCPs+zRd7C3piVBzZX32TXR9NvnF7pDuSKo+U1xDvBA76Uc\r\nOwjktCBUa0SXlhd4m9pTWSXmPY/qTJPh7ogh11y5lv5fTNLsumyC2S0yaWYL\r\nYSljS+SlTARWsCkJeWz5/3cb7MjtU38JioEV11yJZhfTzuSLyZC9oxtaDX41\r\nTrAlPTRdfpelqNWgtcowAa3nl5STVpkTwOk=\r\n=4E3u\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"solidity-docgen","types":"./dist/index.d.ts","author":{"name":"Francisco Giordano","email":"fg@frang.io"},"readme":"# `solidity-docgen`\n\n*solidity-docgen is a program that extracts documentation for a Solidity project.*\n\nThe output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.\n\n## Usage\n\nInstall `solidity-docgen@next` from npm.\n\n### Hardhat\n\nInclude the plugin in your Hardhat configuration.\n\n```diff\n // hardhat.config.ts\n+import 'solidity-docgen';\n\n export default {\n+  docgen: { ... }, // if necessary to customize config\n };\n```\n\nThen run with `hardhat docgen`.\n\n### As a library\n\n```typescript\nimport { docgen } from 'solidity-docgen';\n\nawait docgen([{ output: solcOutput }], config);\n```\n\n`solcOutput` must be the standard JSON output of the compiler, with at least the `ast` output. There can be more than one.\n\n`config` is an optional object with the values as specified below.\n\n## Config\n\nSee [`config.ts`](./src/config.ts) for the list of options and their documentation.\n","gitHead":"3d49c311e0e9c6cf77d05507fa4c62c76b0e997e","license":"MIT","scripts":{"docs":"oz-docs -c docs","test":"hardhat compile && ava","build":"tsc","clean":"hardhat clean && rimraf dist tsconfig.tsbuildinfo","prepare":"npm run clean && npm run build","coverage":"c8 npm run test","docs:watch":"npm run docs watch"},"_npmUser":{"name":"frangio","email":"frangio.1@gmail.com"},"homepage":"https://github.com/OpenZeppelin/solidity-docgen#readme","keywords":["solidity","documentation"],"repository":{"url":"git+https://github.com/OpenZeppelin/solidity-docgen.git","type":"git"},"_npmVersion":"8.3.1","description":"Documentation generator for Solidity smart contracts.","directories":{},"maintainers":[{"name":"frangio","email":"frangio.1@gmail.com"},{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"16.14.0","dependencies":{"handlebars":"^4.7.7","solidity-ast":"^0.4.30"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"c8":"^7.10.0","ava":"^3.15.0","hardhat":"^2.8.0","ts-node":"^10.4.0","code-style":"github:OpenZeppelin/code-style","typescript":"^4.0.0","@types/node":"^12.20.37","@types/mocha":"^7.0.2","openzeppelin-docs-utils":"github:OpenZeppelin/docs-utils"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.6.0-beta.4_1645912952586_0.12518463835834548","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.6.0-beta.4","version":"0.6.0-beta.4"}