package.json
6.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
{
"_args": [
[
{
"raw": "jsdoc",
"scope": null,
"escapedName": "jsdoc",
"name": "jsdoc",
"rawSpec": "",
"spec": "latest",
"type": "tag"
},
"/Users/fzy/project/koa2_Sequelize_project"
]
],
"_from": "jsdoc@latest",
"_id": "jsdoc@3.5.4",
"_inCache": true,
"_location": "/jsdoc",
"_nodeVersion": "8.2.1",
"_npmOperationalInternal": {
"host": "s3://npm-registry-packages",
"tmp": "tmp/jsdoc-3.5.4.tgz_1501884391981_0.32515376643277705"
},
"_npmUser": {
"name": "hegemonic",
"email": "jeffrey.l.williams@gmail.com"
},
"_npmVersion": "5.3.0",
"_phantomChildren": {},
"_requested": {
"raw": "jsdoc",
"scope": null,
"escapedName": "jsdoc",
"name": "jsdoc",
"rawSpec": "",
"spec": "latest",
"type": "tag"
},
"_requiredBy": [
"#DEV:/",
"#USER"
],
"_resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.5.4.tgz",
"_shasum": "ceeef7c4bac4335cb10ff41e3a0f58939a534428",
"_shrinkwrap": null,
"_spec": "jsdoc",
"_where": "/Users/fzy/project/koa2_Sequelize_project",
"author": {
"name": "Michael Mathews",
"email": "micmath@gmail.com"
},
"bin": {
"jsdoc": "./jsdoc.js"
},
"bugs": {
"url": "https://github.com/jsdoc3/jsdoc/issues"
},
"contributors": [
{
"url": "https://github.com/jsdoc3/jsdoc/graphs/contributors"
}
],
"dependencies": {
"babylon": "~7.0.0-beta.19",
"bluebird": "~3.5.0",
"catharsis": "~0.8.9",
"escape-string-regexp": "~1.0.5",
"js2xmlparser": "~3.0.0",
"klaw": "~2.0.0",
"marked": "~0.3.6",
"mkdirp": "~0.5.1",
"requizzle": "~0.2.1",
"strip-json-comments": "~2.0.1",
"taffydb": "2.6.2",
"underscore": "~1.8.3"
},
"description": "An API documentation generator for JavaScript.",
"devDependencies": {
"gulp": "~3.9.1",
"gulp-eslint": "~4.0.0",
"gulp-json-editor": "~2.2.1",
"nyc": "~11.0.3",
"tv4": "https://github.com/hegemonic/tv4/tarball/own-properties"
},
"directories": {},
"dist": {
"integrity": "sha512-VmTw0J+2L16IxAe0JSDSAcH0F+DbZxaj8wN1AjHtKMQU/hO0ciIl5ZE93XqrrFIbknobuqHKJCXZj6+Hk57MjA==",
"shasum": "ceeef7c4bac4335cb10ff41e3a0f58939a534428",
"tarball": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.5.4.tgz"
},
"engines": {
"node": ">=4.2.0"
},
"gitHead": "89a61280267e9249e20a04b85222522608d9a3ba",
"greenkeeper": {
"ignore": [
"taffydb"
]
},
"homepage": "https://github.com/jsdoc3/jsdoc#readme",
"keywords": [
"documentation",
"javascript"
],
"license": "Apache-2.0",
"maintainers": {
"name": "Jeff Williams",
"email": "jeffrey.l.williams@gmail.com"
},
"name": "jsdoc",
"optionalDependencies": {},
"readme": "JSDoc 3\n=======\n\n[](http://travis-ci.org/jsdoc3/jsdoc)\n\nAn API documentation generator for JavaScript.\n\nWant to contribute to JSDoc? Please read `CONTRIBUTING.md`.\n\nInstallation and Usage\n----------------------\n\nJSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's\n`node_modules` folder.\n\nTo install the latest version on npm globally (may require `sudo`; [learn how to fix\nthis](https://docs.npmjs.com/getting-started/fixing-npm-permissions)):\n\n npm install -g jsdoc\n\nTo install the latest version on npm locally and save it in your package's `package.json` file:\n\n npm install --save-dev jsdoc\n\n**Note**: By default, npm adds your package using the caret operator in front of the version number\n(for example, `^3.5.2`). We recommend using the tilde operator instead (for example, `~3.5.2`),\nwhich limits updates to the most recent patch-level version. See [this Stack Overflow\nanswer](https://stackoverflow.com/questions/22343224) for more information about the caret and tilde\noperators.\n\nTo install the latest development version locally, without updating your project's `package.json`\nfile:\n\n npm install git+https://github.com/jsdoc3/jsdoc.git\n\nIf you installed JSDoc locally, the JSDoc command-line tool is available in `./node_modules/.bin`.\nTo generate documentation for the file `yourJavaScriptFile.js`:\n\n ./node_modules/.bin/jsdoc yourJavaScriptFile.js\n\nOr if you installed JSDoc globally, simply run the `jsdoc` command:\n\n jsdoc yourJavaScriptFile.js\n\nBy default, the generated documentation is saved in a directory named `out`. You can use the\n`--destination` (`-d`) option to specify another directory.\n\nRun `jsdoc --help` for a complete list of command-line options.\n\nTemplates and Tools\n-------------------\n\nThe JSDoc community has created numerous templates and other tools to help you generate and\ncustomize your documentation. Here are just a few:\n\n### Templates\n\n+ [jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)\n+ [DocStrap](https://github.com/docstrap/docstrap) ([example](https://docstrap.github.io/docstrap))\n+ [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)\n ([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))\n+ [minami](https://github.com/Nijikokun/minami)\n+ [docdash](https://github.com/clenemt/docdash) ([example](http://clenemt.github.io/docdash/))\n+ [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template) ([example](https://nhnent.github.io/tui.jsdoc-template/latest/))\n\n### Build Tools\n\n+ [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)\n+ [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3)\n\n### Other Tools\n\n+ [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)\n+ [Integrating GitBook with\nJSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)\n\nFor More Information\n--------------------\n\n+ Documentation is available at [Use JSDoc](http://usejsdoc.org).\n+ Contribute to the docs at [jsdoc3/jsdoc3.github.com](https://github.com/jsdoc3/jsdoc3.github.com).\n+ [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/).\n+ Ask for help on the [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).\n+ Post questions tagged `jsdoc` to [Stack\nOverflow](http://stackoverflow.com/questions/tagged/jsdoc).\n\nLicense\n-------\n\nJSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the [contributors to\nJSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).\n\nJSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE.md`\nin this distribution for more details.\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/jsdoc3/jsdoc.git"
},
"revision": "1501884327377",
"scripts": {
"test": "gulp lint; gulp test"
},
"version": "3.5.4"
}