{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"130c9693b32bf01010b5a5fd116617abea956b48","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.24.tgz","fileCount":13,"integrity":"sha512-PWbYcUZdxvQ+r0UMxXO2eZ3WKv2EN15WX3f/RxgINaEb/nszfG1Y7SwBEX5dOFG9tMUKSm+XPxbKiGBkq5S57A==","signatures":[{"sig":"MEUCIQDIw8LEnAR69IwlwbPncc+U3ee655SaFs+tZROpASps+AIgVMK/CGouUSux21EfJ30QFC8b7Ps/PbcP6vT/zJtLg58=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178538,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbtc8tCRA9TVsSAnZWagAAvYoP/AnpYYpXTNJa8LC7loR6\nQD6TOtIzdfFkgQl+TP8yQipaiekTkCWmY5N+VXE9uT3XdXn4/Cp3emgmB7J4\nCr8lEKdS0H08xB10uLa0L3/dIUOOPpMFTxYwShcBkdyAdug6MXxjCJLW087U\njFngIBq/Sjdl2qXoCD641rPBrUsSzoOKY9qTMYVc4aNv6Y0pRL/KHnV8oScB\nXsTAih1dpz0r9+LWkIRH1y4/nEzCKuiK2E0nZkNoQbUtyUHj4K35aVysl0nI\nHEvW58LTR8WKnVZ80mOIIkLmAGyJnxXiZIeqgyOAiyFHkMFS+nP7yGjKVqKC\nu9pCj5F/xLChXo09g0pLQijNauMTA4HBa+3gKEIsGA2gV3gN6ehJ8edD7gqF\npUfPYQOsiUyLzGPo1IWBFBWdxkdZsBNDPTouC1ZwYkcuNw3XDP5VOFoQDRke\nrJ8t/DrxpY3Uaf01+M2+M2TJRzyXAZ76EGk2YFhQIwGN28hPJgJTMqy7k7Na\nMc72oYEB8tAU+gvYqtKBfErfwZ1nOkFzhkAaT7knY+NXG4/JuKpOvQxykN9I\nWJ86ULHj2RER5c7+0NRnuCDrhFbc35/m3HeRyZvjqW0F8xxFpEcj/P1jv4cy\n6nT2hLkwRh5vG6GGj5nXCqXe4cdFa4jkLw7ZR+6gsS/mVGgK3oMJN+s/2nCE\ndeNl\r\n=nrnx\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":"bdc8120ab9456b34e2f67692cc3439ac75c4ba54","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","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.6","@storybook/addons":"4.0.0-alpha.24"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.24_1538641708898_0.46516300269883715","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.24","version":"4.0.0-alpha.24"}