{"bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"dist":{"shasum":"7821978758e0bb1726834d2a932b8efe3937c19f","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.6.0-beta.5.tgz","fileCount":134,"integrity":"sha512-CuiNZ7xUOQ5Ay3xdCnANAshEAxPXdjq6j0OdxWvID6yxLOvx5RRyzOEjslUwLWR6VFzVg9gtX4RToSr97196sQ==","signatures":[{"sig":"MEUCIE1xAOtaaLmY+aTY28LWwyF4vXe6bN3CxFvVp/N4sPexAiEA8zxM5BfASKKMgdFAK99ypuBUDQ5eATya14j0vTow6z0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":118000,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiGqheACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqR2A//aja5L+k5nFKxzc2C/LOdOAtMTGJsWZOGuLrDfyu1P5A8je5b\r\nCGQHe8v1PycFeUfB0Cj0f2plsWZ1rGcbv5IiiRdEBBEYI+sgQOg7FO8T5W8H\r\n+mL3yjv/dg01vSLBCtbJlNxd5L0DBUOQNXX5C00zUFZqF87TtENjoBdBl6KV\r\nFqB5xp5vFud8RqZ8wDvXDoj633GgbCYeBaW4n7sQcHWyQRSuj6xapSf6V/5Q\r\nNuGK/cE5AO2XoL8QijxzACP7rjmbHDswcSst9aHFBYdfZ+Qzp4lHKYdSO9pB\r\nHNIExEQ3SjnL6NsaBAVJ1Vnt4nNzCRZ3xZUHZkqLQjzcXtsHOUQ3cbwYOlH2\r\nf59NgVpWdO4GTRWxkoWbGibjgDMpbExGpAHq43HRO1yOYMXXHLLKPlPXMbYp\r\nKnqdTHV/itrUBwHTbRCvTAtRbHhS1pqVJU7e7QZvCmuikWlecQ+j9VSeUHi4\r\nADfDJdc7MJca/DWI7L/b1Y+pqdq16OWnXGRO/w6/wMXbC7JYZ0cba2O5cexG\r\ndZbLloxSatWRMTTKBi/WMqLpBA69hr+1DJRzCbGsIQwXcrCQ0vqa2X2RK19i\r\nQMwySanN4ZRcqovJL70rxS9NtTWuTPluZ7PNqUakkyYqgCnDiasBEie/QKoT\r\nOGx4SmOY+z2hMdsaUGe9nBch0ct7CHgXzcs=\r\n=I5Ws\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":"63e34bb144e213d093ee0eb7ddace3249c81aa91","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.5_1645914206206_0.16536812003203072","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.6.0-beta.5","version":"0.6.0-beta.5"}