{"bin":{"documentation":"bin/documentation.js"},"bugs":{"url":"https://github.com/documentationjs/documentation/issues"},"dist":{"shasum":"f093a820c9eb58eacbceaa76086baa4f72b28226","tarball":"https://registry.npmjs.org/documentation/-/documentation-14.0.0-alpha.1.tgz","fileCount":107,"integrity":"sha512-LjZDUpPUt87dDp1mXkteLHf1gOuZKPPBdpgee8JRfiNlKKDLvJ8lxETGf4hs4aC33ZeEC9HBPpxFv3VmWj6VtA==","signatures":[{"sig":"MEQCIFwR1l9XRxwjosy9Ht972DUO8FQlLCX/de/HL2vr7RxSAiB0DnwhToLm8YDM6SZkRCeMPUJ9fR9ZjOPvcsPPj08a8g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1851003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi8DQNACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpaXBAAj3Wg0T2Mk81206SDZIIKxQobSkhEPVIQrEEl39J75/oNTZtW\r\nR6bTTw8rbTQ77US7hC0SNnDQYNhRDWEAR1IaMh5JcZDV1RxlQAWNV8gMCcfv\r\nJTcChgJfraWkajiOFFijauHt/hZJ6aeU+iVnAEVrVthaDZ7yYZ6WOIBm8Nyc\r\nxzIEWpUJLsxqF6u905rZQdm4IuBnPMrvPpuL3p8BwHO5O1KIvFyB53cEr0VK\r\nkUZzGC2Eg3cgNd4q/KPbWATkPLZ3QIrEJ/AM05NOi4NHcRZj0a2jxnQbWKSz\r\n2RqGg2pJDxSUGfK+bYGTS2l7H3VCWGF0r4lVwBSlYEL9CzRn573clvsu58bj\r\nwiK8vt8E07jE40Z8MIwFfF/+kyfS8+6CVP9Gwmt+LyhIw/rGjOzpX18w6TjT\r\ntDtV3hybebPeEktIuNHvA8CVpliimR5A3+OZLo4/OjFhQr/bgCoKnEr97AzP\r\nRI1sWLM4W01CFj6Ih48JhIy2dDD+TzLb/9c0Ea5u3HbmrDccjFGPcGsmTXSY\r\nKnOrjvtwSoT7UqDoCcnAKPXPh2Z0ZIrW6J5BeC127AIQP1qfbK9mYEF2biMz\r\nHZr1ezClwR06f9pPbQXywMXfLnJQpQIOhVW5c+iicrmTe5/mTjTXULu+Sln3\r\nReeWlAdhpySJn2CaZs1qiNMDsi3JoFEvXDA=\r\n=h8W5\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"transform":{},"collectCoverage":true,"testEnvironment":"jest-environment-node","moduleNameMapper":{"#(.*)":"<rootDir>/node_modules/$1"},"testPathIgnorePatterns":["/node_modules/","utils.js","fixture"]},"main":"src/index.js","name":"documentation","type":"module","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[![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[![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master&style=flat-square)](http://inch-ci.org/github/documentationjs/documentation)\n\n[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)\n\n- Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.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](https://documentation.js.org/html-example/)\n- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)\n- [JSON](https://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](https://jsdoc.app/about-getting-started.html)-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\ndocumentation build index.js -f md\n\n# generate html docs for all files in src, and include links to source files in github\ndocumentation build src/** -f html --github -o docs\n\n# document index.js, ignoring any files it requires or imports\ndocumentation build index.js -f md --shallow\n\n# validate JSDoc syntax in util.js\ndocumentation lint util.js\n\n# update the API section of README.md with docs from index.js\ndocumentation readme index.js --section=API\n\n# build docs for all values exported by index.js\ndocumentation build --document-exported index.js\n\n# build html docs for a TypeScript project\ndocumentation build index.ts --parse-extension ts -f html -o docs\n\nCommands:\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":">=14"},"gitHead":"460971979602e4aced45d668619b0f7c16e8e181","license":"ISC","scripts":{"doc":"node ./bin/documentation.js build src/index.js -f md --access=public > docs/NODE_API.md","test":"eslint . && node --experimental-vm-modules node_modules/jest/bin/jest.js","build":"npm run doc","format":"prettier --write '{src,__tests__,declarations,bin,default_theme}/**/*.js'","prepare":"husky install","release":"standard-version","test-ci":"eslint . && node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand","self-lint":"node ./bin/documentation.js lint src","pre-commit":"lint-staged"},"_npmUser":{"name":"birkskyum","email":"birk.skyum@pm.me"},"homepage":"https://documentation.js.org","keywords":["documentation","formatter","jsdoc","jsdoc3","parser","website"],"repository":{"url":"git+ssh://git@github.com/documentationjs/documentation.git","type":"git"},"_npmVersion":"8.16.0","description":"a documentation generator","directories":{},"lint-staged":{"*.js":["prettier --write"]},"maintainers":[{"name":"mourner","email":"agafonkin@gmail.com"},{"name":"jfirebaugh","email":"john.firebaugh@gmail.com"},{"name":"tmcw","email":"tom@macwright.com"},{"name":"anandthakker","email":"vestibule@anandthakker.net"},{"name":"birkskyum","email":"birk.skyum@pm.me"}],"_nodeVersion":"16.16.0","dependencies":{"ini":"^3.0.0","diff":"^5.1.0","glob":"^8.0.3","pify":"^6.0.0","chalk":"^5.0.1","konan":"^2.1.1","vfile":"^5.3.4","yargs":"^17.5.1","lodash":"^4.17.21","remark":"^14.0.2","js-yaml":"^4.1.0","resolve":"^1.22.1","chokidar":"^3.5.3","remark-gfm":"^3.0.1","remark-toc":"^8.0.1","vfile-sort":"^3.0.0","@babel/core":"^7.18.10","read-pkg-up":"^9.1.0","remark-html":"^15.0.1","@babel/types":"^7.18.10","globals-docs":"^2.4.1","highlight.js":"^11.6.0","@babel/parser":"^7.18.11","git-url-parse":"^12.0.0","unist-builder":"^3.0.0","github-slugger":"1.4.0","parse-filepath":"^1.0.2","vfile-reporter":"^7.0.4","@babel/traverse":"^7.18.11","@babel/generator":"^7.18.10","unist-util-visit":"^4.1.0","@vue/compiler-sfc":"^3.2.37","mdast-util-inject":"^1.1.0","strip-json-comments":"^5.0.0","vue-template-compiler":"^2.7.8","remark-reference-links":"^6.0.1","doctrine-temporary-fork":"2.1.0","micromark-util-character":"^1.1.0","mdast-util-find-and-replace":"^2.2.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tmp":"^0.2.1","jest":"^28.1.3","chdir":"0.0.0","husky":"^8.0.1","eslint":"^8.21.0","mock-fs":"^5.1.4","fs-extra":"^10.1.0","prettier":"^2.7.1","json-schema":"^0.4.0","lint-staged":"^13.0.3","standard-version":"^9.5.0","documentation-schema":"0.0.1","eslint-config-prettier":"^8.5.0","cz-conventional-changelog":"3.3.0"},"optionalDependencies":{"@vue/compiler-sfc":"^3.2.37","vue-template-compiler":"^2.7.8"},"_npmOperationalInternal":{"tmp":"tmp/documentation_14.0.0-alpha.1_1659909133014_0.15047504667850164","host":"s3://npm-registry-packages"},"_id":"documentation@14.0.0-alpha.1","version":"14.0.0-alpha.1"}