{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"63ad09ceb9c72a9acfd1adef12c44d2a1b66fac8","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.1.0-alpha.3.tgz","fileCount":13,"integrity":"sha512-7AB6b18GLcxrgb/CGMImW97sGeVZHTHwH7KGKBL/C6NaPfHN/lDnHcMvZiQjciJ8MUDZx5UT8gv30w6a/jJBnw==","signatures":[{"sig":"MEUCIQCygxhUhQvNtWmYTgRKEF5zYg49f/DbBkikk9cOreoUZAIgWeY164G42SBsutvCF9rClKIk9Xwp8P/+oTFcCZqN52g=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178527,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb7X9tCRA9TVsSAnZWagAAiccQAIJRyah55WQt0/HzTz7y\nJyV4HuyjCEPZEPiCt2QCXV+jf4SXhNIr1MUGca5xXYM04falEZq/F8De8yJy\nHzCWdxQahxqQBA7epoF0QqmxhRSQfWPhcxga/q9EpAskbnxlDZqX2D11rmLZ\noZ6uHh2LKlU9yQdcSUyyf1V404SDn0gYPhY5UkZaa5U8A1JhzD1Dus/yN19E\nuABR/zr9ZlU9+DxYBT/vmz4MK3943CQKrsSMkTN65jO0a4wXbiSkki8+Z/Kp\n2jnX9Jk4voqv2MzqkEfi/oElcHG5DCd94IidsGbU8B6uxG0M2dQqAIlMfbB8\nohkZcHC9Zcru3f1mSf/MoHVTaK+6nheY6YHtku/srm0lMEsfEswPsvlmFUxZ\nXUN+2/8GtG+zDAc7o+bU2yLktAo07CbMGTz3ZSH2X04WQfa9leoa8T7XFZ/3\nKZHrzgfthuWOr+b2vWAnI8kuWm8+pMNPqWOBCAu2At2n1NQyUimELdB/+1ti\nALtX/Anr4lGf8pniq8PPjGBJcIhlTrDUvMIURfEOXbGh7SGIcN7wH5XvSaOZ\ndDo4+ADDVpbVC92/9C4oAs2B0KnT1t9A8DZ/ZMcCYZ4NiVK1gnouHZWhHY6L\nnUNDFNIl0iRhbEkFDMn4kyVn1We1bAbPfNmrkGWZlJIUHVMwduArgqSQfViL\neJeA\r\n=AlX0\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\n**NOTE: Documentation on master branch is for alpha version, stable release is on [master](https://github.com/storybooks/storybook/tree/master/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).add('with some emoji', () => <Component />, {\n  notes: 'A very simple component',\n});\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('With Markdown', () => <Component />, {\n  notes: { markdown: someMarkdownText },\n});\n```\n","gitHead":"ddecb0b7f6a9e976a32ac4a24c2876d8ff3d6d61","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":"tmeasday","email":"tom@thesnail.org"},{"name":"usulpro","email":"regx@usul.su"}],"dependencies":{"marked":"^0.5.1","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.1.0-alpha.3"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.1.0-alpha.3_1542291309359_0.42241308427392865","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.1.0-alpha.3","version":"4.1.0-alpha.3"}