{"bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"dist":{"shasum":"7fb276ca712bd4facae5cb5477e93fe8478ad5a3","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.6.0-beta.0.tgz","fileCount":116,"integrity":"sha512-cYlybBRfp64Amv5aItuIN0Z94c/NxQNdbsWJQRZwyL9jLOxQ0HKbY/iJxbaXHOZnbYAS/6NKinPx4+sB7z9NDA==","signatures":[{"sig":"MEQCIEE4kQy+y18zvOP+3TgVD5Y3MiJTK9SzwfY1ZQNyynV0AiAeNGtQMIvMn/RZlQI3GmSQpDLTk/OEZa8fYBPI1dXPxQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":92169,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh50ARCRA9TVsSAnZWagAAss0P/2FJU9NUvR5zO4t58bus\nBvyA5AvAWtDsxt8eOLfHjh50PShTuEqrrr/1JSOxF2Lfw82iu8eai/UJRkd7\nDmy5MStyIqXaNkCAH0B8iSZ46oRPxdDc+ebNgdDmB/zqEuJ+u3X7AxFnVEdf\nu6pMuwkmMG+6/SZi0XAYIsCWoo8gIHkPqGGxCdY0HBE4Yjcp/xQf/VyGyjok\nV7c/FN82CpMj0JDrn5JT1aUDx0lLXXTKrupIAjWKlbEzRiBaHxhREE7+x7TC\nmRft42zELI/l0YdsFIkmA38rAD4sZIWQgItNDE4Ts2mCb9IfhvjZSr1C9XGd\n0hrMyIFWXCBB2ptGLExUWNs78wlPk4ikl3lqyPgZQkOqJmGIYxGKWUg3UtvH\nypQLWy8ZHAoZrHBgFxIiojPfeVYPvJSB29QIcFNqhZ1QxlLQUWvTaiYRt5dI\ni37ulyR6/wBhJfBt3MJQnt/++nUsGNPzFZ32nrP93RMU5vZ7e2GHpZRSGCUS\n7x9fjKCm4QS1cvGOiTYDlrWoeeeIaOmn53TvjkXc+hklyocE0DooqsQ13Mtx\npFwPkD05gnNbafQ8M8eWSpfsSWe9kPiAbmalnsrZOXiFFAz+yNQGAsCN/fDc\nHc/y0eChFghXqziSvwsKsW9NAvWfjfr1saluDLffkJMMpvJCRNUa8aO/V6R5\nmaph\r\n=TYjz\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":"06a54e5016a4c102530aec199d0cbb0d029e178a","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.1.2","description":"Documentation generator for Solidity smart contracts.","directories":{},"maintainers":[{"name":"frangio","email":"frangio.1@gmail.com"},{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"16.13.1","dependencies":{"handlebars":"^4.7.7","solidity-ast":"^0.4.28"},"_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.0_1642545169022_0.7905762394439229","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.6.0-beta.0","version":"0.6.0-beta.0"}