{"_id":"@anthonymartin/solidity-docgen","_rev":"1-fdadffb3bbbaa0dbdb46b60e035d0684","name":"@anthonymartin/solidity-docgen","dist-tags":{"latest":"0.5.13"},"versions":{"0.5.13":{"name":"@anthonymartin/solidity-docgen","version":"0.5.13","description":"Solidity API documentation automatic generator.","repository":{"type":"git","url":"git+https://github.com/OpenZeppelin/solidity-docgen.git"},"bin":{"solidity-docgen":"dist/cli.js"},"scripts":{"build":"tsc","build:watch":"tsc --watch","coverage":"nyc yarn test","docs":"oz-docs -c docs","docs:watch":"yarn docs watch","test":"tsc && ava","test:watch":"fgbg 'ava --watch' 'tsc --watch' --","prepublish":"rimraf dist tsconfig.tsbuildinfo","prepare":"yarn build"},"dependencies":{"@oclif/command":"^1.8.0","@oclif/config":"^1.17.0","@oclif/errors":"^1.3.3","@oclif/plugin-help":"^3.2.0","globby":"^11.0.0","handlebars":"^4.7.6","json5":"^2.1.3","lodash":"^4.17.15","micromatch":"^4.0.2","minimatch":"^3.0.4","semver":"^7.3.2","solc":"^0.6.7"},"devDependencies":{"@ava/typescript":"^2.0.0","@openzeppelin/contracts":"^4.0.0","@types/json5":"0.0.30","@types/lodash":"^4.14.161","@types/micromatch":"^4.0.1","@types/minimatch":"^3.0.3","@types/node":"^10.17.29","@types/semver":"^7.3.3","ava":"^3.8.2","code-style":"github:OpenZeppelin/code-style","fgbg":"^0.1.4","nyc":"^15.0.1","openzeppelin-docs-utils":"github:OpenZeppelin/docs-utils","promisified":"^0.5.0","rimraf":"^3.0.2","solc-0-4":"npm:solc@^0.4.24","solc-0-5":"npm:solc@^0.5.14","solc-0-7":"npm:solc@^0.7.0","solc-0-8":"npm:solc@^0.8.2","typescript":"^4.0.0"},"keywords":["solidity","api","documentation","automatic","generator"],"license":"MIT","gitHead":"a02133431b3ba8466a1adfa90bd59d666a85035a","bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"homepage":"https://github.com/OpenZeppelin/solidity-docgen#readme","_id":"@anthonymartin/solidity-docgen@0.5.13","_nodeVersion":"15.14.0","_npmVersion":"7.7.6","dist":{"integrity":"sha512-K38Vv5n2MmS4uap9+R3hYTm/jRlTKidYI2VaOBt+w3CPiUpkZYDq9eFSIiPqUHDduvxbdGIGh5+jlCrtovTgBw==","shasum":"7950eb81fbc4ebbf28c12cea9534e1882fd0e505","tarball":"https://registry.npmjs.org/@anthonymartin/solidity-docgen/-/solidity-docgen-0.5.13.tgz","fileCount":103,"unpackedSize":216274,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhMAW4CRA9TVsSAnZWagAA0coP/1VE/YiEQk44sALlfZqD\nHC2Yb/dpZPxuIPD2piuhW+0kdWN4Ca38UM6WCHAIVcoGrU65NfGIl8CFVhgG\n3Vkmyp1AcECSpiJA0ac4vBaq2LdzPlMtX2+ppR7k1IG2LSp6VRitMGE7J6KS\n1v6ynOzpwCocUrKW5YVfzs65+YL+ohqcOGMVqwEeqcebXbJ3HySRYu26uX2d\n046f/1xhzuUCYVSLv3uiomeg5FLXVwB6tWIDszrMgnkP0Dl5eBDcluV0Oizv\ncd+U3wM5ULzg9MGLEjFH3/rrZ+Kumfxa4pxJIb9NHQFLhciOgHjF2lyYDJJZ\n4umumyQVccEEDYb972MNhh/TkhEmOATi597KLzBAIRVPiF62eXT6aC7TA/DO\nQkQyBg0rYWaxpHIDqsJW4NSByopdWFJ+sQFfgOA+2xWYuA5N43c2NONWX5+e\nkKBwtIrlKcEFIYPfUeCYUynvhxvOrzBU/7pw25gAGcnaECne+To11m4STD/x\nhFkMV+HiHcAP4nuWLZe34cQHiL8YkvxnUkllaEzEn4a3mSO0DTNsjMNwKF4H\n82nIKY0h0TCOESp2sgUVVAHWipPyjbln8ai4s7FzTbbNCqaQVVSliVtEQ7HF\n/cvZ61OsK241RwfygRjNd19biM4xHam0IthCU7Qm3VZ+hl705x2ns+wZQSlQ\nJH7n\r\n=Qc8W\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDzAJ5HoVgWlXERGOUrWn6EBgs3SPuBMaZwurimJmKc9AIhAIC0plP/hC/w7K++0siuHxiGNNjTTrV+ciNJROpQ4DWP"}]},"_npmUser":{"name":"anthonymartin","email":"anthony@replaycreative.com"},"directories":{},"maintainers":[{"name":"anthonymartin","email":"anthony@replaycreative.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/solidity-docgen_0.5.13_1630537143912_0.5936732441433581"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-01T22:59:03.836Z","0.5.13":"2021-09-01T22:59:04.093Z","modified":"2022-04-04T14:21:46.596Z"},"maintainers":[{"name":"anthonymartin","email":"anthony@replaycreative.com"}],"description":"Solidity API documentation automatic generator.","homepage":"https://github.com/OpenZeppelin/solidity-docgen#readme","keywords":["solidity","api","documentation","automatic","generator"],"repository":{"type":"git","url":"git+https://github.com/OpenZeppelin/solidity-docgen.git"},"bugs":{"url":"https://github.com/OpenZeppelin/solidity-docgen/issues"},"license":"MIT","readme":"# `solidity-docgen`\n\n**Documentation generator for smart contract libraries.** Use the inline\ndocumentation in your Solidity code for generating websites or any sort of\ndocument.\n\nThe output is completely customizable through Handlebars templates that provide\neasy access to all the metadata of your smart contract.\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### Solidity 0.7\n\nThe built in compiler remains solc 0.6, but users who want to use the newer compiler version can do so by installing the desired solc version and using the flag `--solc-module`. Here's an example using npm aliases:\n```\nnpm install -D solc-0.7@npm:solc@^0.7.0\nnpx solidity-docgen --solc-module solc-0.7\n```","readmeFilename":"README.md"}