{"bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"dist":{"shasum":"275d8d26e3a326cb3b8203b1ad944bac65aafe84","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.6.0-beta.6.tgz","fileCount":134,"integrity":"sha512-kCYW6M3VvI7z0HEt2KXzhOWDAVUFz4fifq5jZE1W06OyKEZ7H5ylfaBrPkL+Lal8gyhWhVdAb9T25DK/H9HYyw==","signatures":[{"sig":"MEQCIFsjUfksUanVz+JONvbAXlLZjURGuxdWn/U2T/q+kpi0AiBN7Z6jjaq4vIOM86XwGkDQ9jbeW6hqfwjiFE4Ny+RXTA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":118085,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiGqscACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqvdQ//e3B3VE16dmhGeVXKcaZFPSTcdAIq/u2dSraGMgVCV50dNHVY\r\nAi9pOtRVoE5acmklxoX5fcPf/YZ6IivYDffvGEP3XWPWs26qrvPSJbsSVQ7n\r\nLao1M+h9J3KuEcOkazH1lzN2q0P0KYA/cLHoqoB/CxVsiQHtwh8wnN4lx7Zi\r\nADXJXFXQpnIrx2WTXHhdsesWJ5SY6zMua4+ajtM8MuxKFCfSrYRqbiBHdisE\r\ns5zfBfT19Fptst4Pljsd6bbsqVun9yzSP1jgB5k+z+2gppa8uxwrdta1NV4N\r\nYA9EfRKuSVij6+Y0b2CSyf+BtGSjP+3F4JSGqweImVk1o107XqxseSU/7yOh\r\nq+vQ417mzfcyLLtXqoqPCTP7eLexWfJy0rS/vjY7rTZaR1O6VpTHMZWo5Ud5\r\nIYJMWPj45swGnpRFNlGJkEzN6RfuPH9AdrsyqLE/yMgFRDCCiVjnqX9ecfEx\r\nxFcFcsVb81g9jQjFIOZQRmcV2AyNFQZFzLTTbkMPJ/8ty6C8B4/ImkeZp2s5\r\nV92MbY8hHnxppNG+5OQLIZzBPNxGTtofsQmQjAwuZv33ltIQ1OunXqTrVjho\r\nsFMobG5mzjB0BckI6ErDLE32AF0UTBQMi+QaihHdfF10sB25Cw6m9FQXPswm\r\nQl4hAR2zZakikCgpLup7LHL0pQvRkpdGdo0=\r\n=Ygx2\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":"a8dfb45824f9706ce75a44d1c7d8b377aac6aa1e","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"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.6.0-beta.6_1645914908666_0.513165323814657","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.6.0-beta.6","version":"0.6.0-beta.6"}