{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"4d29a3fa6e4766530f8996be2b777d60af29c7eb","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.22.tgz","fileCount":13,"integrity":"sha512-LLtyjR0avFMi3xe4wyRfNZpa7jOQPaWLGaD45REikPftUwlOsWxuEnjhuaHHoR255ls47UUnqyX2QtWC0xBJRg==","signatures":[{"sig":"MEUCIQCQeL9XBHOVOfpHEeU6Y6vedJsIaoLVTz+3hW1rT++AwwIgDPJ2MGzlX6Us3IYcaIbtl3n5q28cQ9N4xwaCC3dRrAQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178605,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbornVCRA9TVsSAnZWagAA30EP/0PJunEPIgfhdHnKKkND\n3Tbrwaq22xMAfFah6GIx+7yyasoOOkf1y0iTPiUgfolrW98VaHtZKffbOvMH\nop8+9TW3n+ekXzjC+G/TKURTAR04h+D6PLnmwvBCw9PL5WLVKeZiS0EreyhG\nKpptu+lHD0vdcogpEVn+fiu3KyEQAN8tehHqvynSfnqbUVP6rucfhjhAmE78\ng6e8NUJaZGhdE/w/zX/72vXxu7e2788j4XMnElDuX5X7PmpcVMqtIvy1W2wq\noijMWQkiltJxrmBanBPFCkUlyGFw0rUe9SN7Ia1wqNYC4DaIpkTYVReGsrPs\nQuTc8SF/f/14ElCsbSOCoY2Ts4Jc2XGIrcLg9BOXxtNkJ7JhJ+VPw2cP09ay\nZ8CK4D/eWku78Ajg1wkAJdjlU46D5+L1JBoq0uKZdt990fqlhGJIFTv3SkCi\n+C2t+7QZmLBjrvriIHFDXrbrJtDoqIqJ1BMmWagaBEnPoXAfyFo7dVhplbBf\n05kv0qbsNft3pgXjxELgtR8V6ZFTb7s7BqsPsaU6OaA9x04CVlVLR8q0ac3a\nSLOyW5ae57u27o7uc+RzBiloMEAYkJPwWWe+JxEr37lr8/6WNdMj8Qo3vP74\nvL9UUntgXj9HvjbkywRz/WUEA5xX8tLZ/oWp8K0N4o9xhL8PMi8vbQ9zbOuN\nhnYC\r\n=rcCq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-notes","readme":"# Storybook Addon Notes\n\nStorybook Addon Notes allows you to write notes (text or HTML) for your stories in [Storybook](https://storybook.js.org).\n\n[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)\n\n![Storybook Addon Notes Demo](docs/demo.png)\n\n### Getting Started\n**NOTE: Documentation on master branch is for alpha version, stable release is on [release/3.4](https://github.com/storybooks/storybook/tree/release/3.4/addons/)**\n\n```sh\nyarn add -D @storybook/addon-notes\n```\n\nThen create a file called `addons.js` in your storybook config.\n\nAdd following content to it:\n\n```js\nimport '@storybook/addon-notes/register';\n```\n\nThen add the `withNotes` decorator to all stories in your `config.js`:\n\n```js\n// Import from @storybook/X where X is your framework\nimport { configure, addDecorator } from '@storybook/react';\nimport { withNotes } from '@storybook/addon-notes';\n\naddDecorator(withNotes);\n```\n\nYou can use the `notes` parameter to add a note to each story:\n\n```js\nimport { storiesOf } from '@storybook/react';\n\nimport Component from './Component';\n\nstoriesOf('Component', module)\n  .add('with some emoji', () => <Component />, { notes: 'A very simple component' });\n```\n\n#### Using Markdown\n\nTo use markdown in your notes, either through import or inline, simply put it in the `markdown` property of your note.\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport Component from './Component';\nimport someMarkdownText from './someMarkdownText.md';\n\nstoriesOf('Component', module).add(\n  'With Markdown',\n  () => <Component />,\n  { notes: { markdown: someMarkdownText } }\n);\n```\n","gitHead":"5112b520041c4aad100ad7eeb3487e534c64e48b","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybooks/storybook/tree/master/addons/notes","keywords":["addon","notes","storybook"],"repository":{"url":"https://github.com/storybooks/storybook.git","type":"git"},"description":"Write notes for your Storybook stories.","directories":{},"jsnext:main":"src/index.js","licenseText":"The MIT License (MIT)\n\nCopyright (c) 2017 Kadira Inc. <hello@kadira.io>\n\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\nall copies 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\nTHE SOFTWARE.\n","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"christianalfoni","email":"christianalfoni@gmail.com"},{"name":"danielduan","email":"dduan@yahoo.com"},{"name":"hypnosphi","email":"talpa@yandex.ru"},{"name":"igor-dv","email":"davydkin.igor@gmail.com"},{"name":"ndelangen","email":"ndelangen@me.com"},{"name":"pksunkara","email":"pavan.sss1991@gmail.com"},{"name":"shilman","email":"michael@lab80.co"},{"name":"usulpro","email":"regx@usul.su"}],"dependencies":{"marked":"^0.5.0","prop-types":"^15.6.2","@emotion/styled":"0.10.5","@storybook/addons":"4.0.0-alpha.22"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.22_1537391060403_0.9888192564232858","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.22","version":"4.0.0-alpha.22"}