{"_id":"@beisen/react-doc-generator","_rev":"3-2ddfa5e3ce27a22a677975b66ba645df","name":"@beisen/react-doc-generator","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@beisen/react-doc-generator","version":"0.0.1","description":"[![npm version](https://img.shields.io/npm/v/react-doc-generator.svg?style=flat-square)](https://www.npmjs.com/package/react-doc-generator) [![dependency status](https://img.shields.io/david/marborkowski/react-doc-generator.svg?style=flat-square)](https:/","main":"dist/index.js","bin":{"react-doc-generator":"dist/react-doc-generator.js"},"scripts":{"lint":"eslint src","transpile":"babel src -D -d dist --ignore '__tests__, __mocks__'","watch":"babel src -D -d dist --ignore '__tests__,__mocks__' --watch","pretest":"npm run transpile","preversion":"npm run lint","test":"jest"},"dependencies":{"cli-table":"^0.3.1","colors":"^1.1.2","commander":"2.9.0","handlebars":"^4.0.6","node-dir":"^0.1.16","react":"^15.6.2","react-docgen":"^2.13.0","react-dom":"^15.6.2","prop-types":"^15.6.0"},"devDependencies":{"babel-cli":"^6.23.0","babel-eslint":"^7.1.1","babel-jest":"^19.0.0","babel-preset-env":"^1.2.0","eslint":"^3.17.0","eslint-config-react-app":"^0.5.2","eslint-plugin-flowtype":"^2.30.0","eslint-plugin-import":"^2.2.0","eslint-plugin-jsx-a11y":"^2.2.3","eslint-plugin-react":"^6.10.0","jest-cli":"^19.0.2"},"gitHead":"d223720daa933d1eecf13d76044103991d601923","_id":"@beisen/react-doc-generator@0.0.1","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"beisencorp","email":"ci@beisen.com"},"dist":{"integrity":"sha512-UFtmFgRyoebKgMW9BxoxXS6fhkxbB1SgIg4yPCTdhxt0GEZftnzA3xF6zC6VnZmwOgRsiUAJyhXXpqs0NCAxCg==","shasum":"d94ec096d9f5b3b801dc8490bd33ef204e04ae08","tarball":"https://registry.npmjs.org/@beisen/react-doc-generator/-/react-doc-generator-0.0.1.tgz","fileCount":13,"unpackedSize":25554,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbMLdECRA9TVsSAnZWagAA0EUP/3LZ3JwJYSVino91NMSH\nDmbRVTUh7IXtSWScvr8EBVoQ4Hl44B+pqqggGrzSs8OcZ4wRwfFGuiHrPoBb\nneEpVvPGTyb7U67lQcyiMiyObcQfm80LGcz+KTQC5sutM+3nBKF0mUyQJLSC\n0POD+A6AhYzx4MKDGnQtYO08Sh0UU7VJzCiETM0IFXn9v4fN8E/roc6IH1Jh\nWM4u3HNO9gbUhYse+RPhDf0oTCt3f3I37Pzgq8HoiuT0lOvxnKzD81Z4tPpC\nUm736CrTqjzEH7RhWgw9eDMDfXDCPgVKYytFbMfGolJSuJqE8HtIzEhHrjxB\nNDCIE5G61NUM342Pf+aK0ibkNKVZeVUl3aH7z6lHXZ/867D+kSojoPbzGWqa\nBnavaZVS4Siygt+J80GxgNz6cbxLQo/mK3esSa7zpnH6UO7lShUFiFoMzVtl\ni6uHpRBqVu5fdovwGADoDS/GGDk30vVJRSNS4L4QEmNXd7JsNOx7EY40rBGc\nEsXnUzWi657cZcnuzTVR8qybcVNdAUdSRjGeUjk02wSEh98Ove3cHX/82rBb\nKooYrKz6w9jEo9sPgv2g5636wlkb0fORNL1PceV8vhaMys/MXbh8GVBAflwl\nOrjKpZYgeqb2JwoM6Xt5fJhAEx3kFbYQC7/gQpxoH4UZCkjUIsN2CugeE1vS\nT0J1\r\n=mui8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDoIDv5V8dy8p7VqshNheMv+OVr4yWggwtyiQ0K6bLi3wIhAORV79+xDI/uPOrRzDrsVDw3t5Ka7MDi67LH443z/NoF"}]},"maintainers":[{"name":"beisencorp","email":"ci@beisen.com"},{"name":"lgm","email":"it1011@qq.com"},{"name":"neozw","email":"lihegaozhong@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-doc-generator_0.0.1_1529919300303_0.849542629166206"},"_hasShrinkwrap":false}},"time":{"created":"2018-06-25T09:35:00.088Z","0.0.1":"2018-06-25T09:35:00.444Z","modified":"2022-04-04T18:19:13.438Z"},"maintainers":[{"email":"albertzhang.pro@gmail.com","name":"albert-zhang"},{"email":"liugenpeng@beisen.com","name":"liugenpeng"},{"email":"ci@beisen.com","name":"beisencorp"},{"email":"it1011@qq.com","name":"lgm"},{"email":"lihegaozhong@gmail.com","name":"neozw"}],"description":"[![npm version](https://img.shields.io/npm/v/react-doc-generator.svg?style=flat-square)](https://www.npmjs.com/package/react-doc-generator) [![dependency status](https://img.shields.io/david/marborkowski/react-doc-generator.svg?style=flat-square)](https:/","readme":"# React DOC Generator\n[![npm version](https://img.shields.io/npm/v/react-doc-generator.svg?style=flat-square)](https://www.npmjs.com/package/react-doc-generator)\n[![dependency status](https://img.shields.io/david/marborkowski/react-doc-generator.svg?style=flat-square)](https://david-dm.org/marborkowski/react-doc-generator)\n[![build status](https://img.shields.io/travis/marborkowski/react-doc-generator.svg?style=flat-square)](https://travis-ci.org/marborkowski/react-doc-generator)\n\nGenerate simple React components documentation in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).\n\n## Installation\n\n`$ npm install -save-dev react-doc-generator`\n\n## Usage\n\nCheck every option runnig `react-doc-generator` with `--help` or `-h`:\n\n```\n$ react-doc-generator --help\n\nUsage: react-doc-generator [options]\n\nOptions:\n\n -h, --help output usage information\n -V, --version output the version number\n -x, --extensions Include only these file extensions. Default: js,jsx\n -i, --ignore Folders to ignore. Default: node_modules,__tests__,__mocks__\n -e, --exclude-patterns Filename patterns to exclude. Default: []\n -t, --title [value]> Document title. Default: 'Components'\n -o, --output Markdown file to write. Default: 'README.MD'\n```\n\n### By the command line\n\nExample:\n\n`$ react-doc-generator src -o DOCUMENTATION.md`\n\n### NPM script\n\nExample:\n\nIn your `package.json` put:\n```\n{\n // ...\n \"scripts\": {\n \"doc\": \"react-doc-generator ./app/components/custom -o DOCUMENTATION.md\"\n }\n // ...\n}\n```\n\nso then you are able to call this script by the command line:\n\n`$ npm run doc`\n\n## API\n\n```js\n/**\n * General component description.\n * You can even use the native Markdown here.\n * E.g.:\n * ```html\n * \n * ```\n */\nexport class MyComponent extends React.Component {\n static displayName = 'Official Component Name'\n static propTypes = {\n /**\n * Description of prop \"foo\".\n */\n foo: React.PropTypes.number,\n /**\n * Description of prop \"bar\" (a custom validation function).\n */\n bar: function(props, propName, componentName) {\n // ...\n },\n baz: React.PropTypes.oneOfType([\n React.PropTypes.number,\n React.PropTypes.string\n ]),\n }\n\n static defaultProps = {\n foo: 10000099999\n }\n\n render () {\n return (
Hello
);\n }\n}\n```\n\nBecause [**react-doc-generator**](https://github.com/marborkowski/react-doc-generator) uses [**react-docgen**](https://github.com/reactjs/react-docgen) library, you can [follow other examples here](https://github.com/reactjs/react-docgen).\n\n## Demo\n\n * [Example output](https://github.com/marborkowski/react-doc-generator/blob/master/demo/DOCUMENTATION.md)\n\n## Terminal\n\nThis is an example of what you'll see in your terminal.\n\n![Terminal](https://raw.githubusercontent.com/marborkowski/react-doc-generator/master/demo/terminal.png)\n\n### License\n\nMIT License \nCopyright (c) 2017 Marcin Borkowski () \nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","readmeFilename":"README.md"}