{"bin":{"documentation":"./bin/documentation.js"},"bugs":{"url":"https://github.com/documentationjs/documentation/issues"},"dist":{"shasum":"fbc7b805175f4b87f486aca1d29cb27c7bbca93e","tarball":"https://registry.npmjs.org/documentation/-/documentation-9.0.0-alpha.0.tgz","fileCount":197,"integrity":"sha512-fV93R6Dqs0cjvVjjmAK9c5wcFYo9j95oXL3yibJzlTZO2y1hHVHMN+xyD7YeSWKkqz+jWafYRXnJ/vIBYNq80g==","signatures":[{"sig":"MEUCIQDezjOfXfDifW3FN6OvM2zAN7+V7tmx3H0rcS2V19na0AIgGNiXls4mh19xAlUtvegE3GvdCHgn6kHOktyLknMywuw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3827946,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbpI5eCRA9TVsSAnZWagAAHiQP/1r0MgZXJOtW8OvqE2WQ\nMwYGnRLyO+FAHKkD9AUUPkeL0GYoK0dwLD1XXZH0gmpsundLZ3sz3DU9rT3F\nZw+yvpZVxhfMV+MsChhEYSXfauStgycrhOTHNb7OwoVMiAzfpgASaxmhkZsq\n1FYe6xqxyIRCgOLhglHhsGkTtXq5ywWyuvaStIY3LrodCM7JiawTdIE6neaK\n55wRoDtz1Qb0oHOcDSMiOye6l/NLwORi5Veo3ac5AkBMesqH1QKkkYM34gYY\nAcYaYKHjayvFxpcaLs70t0awqbOesnznS+ZXc8KCEYaJdWBi09zxJwriCrZM\nPN+19M4MIxM3CndNLgUbnKSnsUa4ClAW3zYTC6KabRs/IULOgK4Dj+l5gcJD\nn9/HeCSl3FoPgdCMjVd7CGNtjD5jttL8sobZ1LYsvgyOIQnvAHR0LTLYSORU\nvTbzn8OQggjGdPYNwszGpdYDCyUq4XEVkE1GHNewsl0vsT2KjFQQU4cNF2s2\nbdAMDLPTDfoA09RwFOCpMKeL7hvsBhEkQehMZbxZIRcZVQX8UnvqO7W6Fvc4\nJusX/cS2rklGkhgvliW66ZOuYkbHUSZo/VD3ioB6MXd0ma9yY3lYBDvfCfXC\n5ebbmYcJrgq/djV31K1D+luRlNjPeBb4AO+gCutJseANygoE8ePzo1MzuScH\nBVyf\r\n=EJrv\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"collectCoverage":true,"testEnvironment":"node","testPathIgnorePatterns":["/node_modules/","utils.js","fixture"],"coveragePathIgnorePatterns":["<rootDir>/lib/"]},"main":"lib/index.js","name":"documentation","author":{"name":"Tom MacWright"},"config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"<p align=\"center\">\n  <img src=\"./.github/documentation-js-logo.png\" width=\"650\" />\n</p>\n\n<p align=\"center\">\n  The documentation system for modern JavaScript\n</p>\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/documentation.svg)](https://greenkeeper.io/)\n[![Circle CI](https://circleci.com/gh/documentationjs/documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/documentation/tree/master)\n[![npm version](https://badge.fury.io/js/documentation.svg)](http://badge.fury.io/js/documentation)\n[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\n[![David](https://david-dm.org/documentationjs/documentation.svg)](https://david-dm.org/documentationjs/documentation)\n[![Coverage Status](https://coveralls.io/repos/github/documentationjs/documentation/badge.svg?branch=master)](https://coveralls.io/github/documentationjs/documentation?branch=master)\n[![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master&style=flat-square)](http://inch-ci.org/github/documentationjs/documentation)\n\n* Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](http://flowtype.org/) type annotations.\n* Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.\n* Integrates with GitHub to link directly from documentation to the code it refers to.\n* Customizable output: HTML, JSON, Markdown, and more\n\n## Examples\n\n-   [HTML output with default template](http://documentation.js.org/html-example/)\n-   [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)\n-   [JSON](http://documentation.js.org/html-example/index.json)\n\n## Documentation\n\n-   [Getting Started](docs/GETTING_STARTED.md): start here\n-   [Usage](docs/USAGE.md): how to use documentation.js\n-   [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs\n-   [Node API](docs/NODE_API.md): documentation.js's self-generated documentation\n-   [Configuring documentation.js](docs/CONFIG.md)\n-   [FAQ](docs/FAQ.md)\n-   [Troubleshooting](docs/TROUBLESHOOTING.md)\n-   [Theming](docs/THEMING.md): tips for theming documentation output in HTML\n-   [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js\n\n## User Guide\n\nGlobally install `documentation` using the [npm](https://www.npmjs.com/) package manager:\n\n```sh\n$ npm install -g documentation\n```\n\nThis installs a command called `documentation` in your path, that you can\npoint at [JSDoc](http://usejsdoc.org/)-annotated source code to generate\nhuman-readable documentation. First, run `documentation` with the `--help`\noption for help:\n\n```sh\nUsage:\n\n# generate markdown docs for index.js and files it references\nbin/documentation.js build index.js -f md\n\n# generate html docs for all files in src\nbin/documentation.js build src/** -f html -o docs\n\n# document index.js, ignoring any files it requires or imports\nbin/documentation.js build index.js -f md --shallow\n\n# build and serve HTML docs for app.js\nbin/documentation.js serve app.js\n\n# build, serve, and live-update HTML docs for app.js\nbin/documentation.js serve --watch app.js\n\n# validate JSDoc syntax in util.js\nbin/documentation.js lint util.js\n\n# update the API section of README.md with docs from index.js\nbin/documentation.js readme index.js --section=API\n\n# build docs for all values exported by index.js\nbin/documentation.js build --document-exported index.js\n\nCommands:\n  serve [input..]   generate, update, and display HTML documentation\n  build [input..]   build documentation\n  lint [input..]    check for common style and uniformity mistakes\n  readme [input..]  inject documentation into your README.md\n\nOptions:\n  --version  Show version number                                       [boolean]\n  --help     Show help                                                 [boolean]\n```\n\n## [Contributing](CONTRIBUTING.md)\n\n_We have plenty of\n[issues](https://github.com/documentationjs/documentation/issues) that we'd\nlove help with._\n\n-   Robust and complete `JSDoc` support, including typedefs.\n-   Strong support for HTML and Markdown output\n-   Documentation coverage, statistics, and validation\n\ndocumentation is an OPEN Open Source Project. This means that:\n\nIndividuals making significant and valuable contributions are given\ncommit-access to the project to contribute as they see fit. This\nproject is more like an open wiki than a standard guarded open source project.\n","engines":{"node":">=4"},"gitHead":"7ce2a6a803acaa77940c847ab54390162ac5ef24","license":"ISC","scripts":{"doc":"node ./bin/documentation.js build src/index.js -f md --access=public > docs/NODE_API.md","test":"npm run build && eslint . && flow check && jest","build":"rm -rf lib && babel -D src -d lib && npm run doc","format":"prettier --write '{src,__tests__,declarations,bin,default_theme}/**/*.js'","release":"standard-version","test-ci":"npm run build && eslint . && flow check && jest --runInBand","precommit":"lint-staged","self-lint":"node ./bin/documentation.js lint src","prepublish":"npm run build"},"_npmUser":{"name":"tmcw","email":"tom@macwright.org"},"homepage":"https://github.com/documentationjs/documentation#readme","keywords":["documentation","formatter","jsdoc","jsdoc3","parser","website"],"repository":{"url":"git+ssh://git@github.com/documentationjs/documentation.git","type":"git"},"_npmVersion":"6.4.1","description":"a documentation generator","directories":{},"greenkeeper":{"ignore":["remote-origin-url"]},"lint-staged":{"*.js":["prettier --write","git add"]},"maintainers":[{"name":"anandthakker","email":"vestibule@anandthakker.net"},{"name":"jfirebaugh","email":"john.firebaugh@gmail.com"},{"name":"mourner","email":"agafonkin@gmail.com"},{"name":"tmcw","email":"tom@macwright.org"}],"_nodeVersion":"10.8.0","dependencies":{"glob":"^7.1.2","mime":"^2.2.0","pify":"^4.0.0","chalk":"^2.3.0","vfile":"^3.0.0","vinyl":"^2.1.0","yargs":"^9.0.1","lodash":"^4.17.10","remark":"^9.0.0","js-yaml":"^3.10.0","tiny-lr":"^1.1.0","babelify":"^10.0.0","chokidar":"^2.0.0","get-port":"^4.0.0","vinyl-fs":"^3.0.2","ansi-html":"^0.0.7","disparity":"^2.0.0","micromatch":"^3.1.5","remark-toc":"^5.0.0","vfile-sort":"^2.1.0","@babel/core":"^7.0.0","read-pkg-up":"^4.0.0","remark-html":"^8.0.0","@babel/types":"^7.0.0","globals-docs":"^2.4.0","highlight.js":"^9.12.0","stream-array":"^1.1.2","@babel/parser":"7.1.0","concat-stream":"^1.6.0","git-url-parse":"^10.0.1","unist-builder":"^1.0.2","github-slugger":"1.2.0","parse-filepath":"^1.0.2","vfile-reporter":"^5.0.0","@babel/traverse":"^7.1.0","@babel/generator":"^7.0.0","unist-util-visit":"^1.3.0","@babel/preset-env":"^7.0.0","mdast-util-inject":"^1.1.0","remote-origin-url":"0.4.0","@babel/preset-flow":"^7.0.0","@babel/preset-react":"^7.0.0","strip-json-comments":"^2.0.1","module-deps-sortable":"5.0.0","@babel/preset-stage-0":"^7.0.0","vue-template-compiler":"^2.5.16","remark-reference-links":"^4.0.1","doctrine-temporary-fork":"2.0.1","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tmp":"^0.0.33","jest":"^23.0.0","chdir":"0.0.0","husky":"^0.14.3","eslint":"^5.0.1","mock-fs":"^4.4.2","p-event":"^2.0.0","flow-bin":"^0.73.0","fs-extra":"^7.0.0","prettier":"^1.10.2","coveralls":"^3.0.0","@babel/cli":"^7.0.0","babel-core":"^7.0.0-bridge.0","babel-jest":"^23.4.2","json-schema":"0.2.3","lint-staged":"^7.2.0","babel-eslint":"^9.0.0","are-we-flow-yet":"^1.0.0","standard-version":"^4.3.0","regenerator-runtime":"^0.12.0","documentation-schema":"0.0.1","eslint-config-prettier":"^3.0.1","eslint-plugin-flowtype":"^2.41.0","cz-conventional-changelog":"2.1.0","@babel/plugin-transform-modules-commonjs":"^7.1.0","@babel/plugin-transform-async-to-generator":"^7.1.0"},"_npmOperationalInternal":{"tmp":"tmp/documentation_9.0.0-alpha.0_1537511005202_0.7084919122202582","host":"s3://npm-registry-packages"},"_id":"documentation@9.0.0-alpha.0","version":"9.0.0-alpha.0"}