{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"778139e88c24fe628f1c6fb2f11f638d771e137d","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-rc.2.tgz","fileCount":13,"integrity":"sha512-yEOhD9bFZfSEuQYNqobBf8s8FjcnVwg6CrdO0UtWGQDeRXYFs0d/5F2eqiB/sHlMbhaxQx7if0YQ/N2mve7dQQ==","signatures":[{"sig":"MEQCIGf41+Kdh4cZnTvHoYSs25NhOjB6h09gFHsq6Q4Ev3/sAiATl4YqMrd5cGlTpzCMTUH1K+3YcxdxlR0Rlgieumv2Ug==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178530,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbzdPyCRA9TVsSAnZWagAALtQP/jRBjJYIuquNP3bbZ2iZ\nVqoeimzEDMiG9kfkJU8lim437RzfIEG3Qh6BYX4GOBBFwO5by1PiaqrmZFGt\nGgWwSA9A11kw8HI5x6qpQnrECRLReYzZs3YCNIhseJTPWttB2QkcEue3jD1P\nrpXeQDtSFBw37y1HzBtWXTfhscBVuAOCmMjbv5c8vx9tzrVMkw+PqXK3J4vp\njKcV+vtNzodqvnAjK7S9FqQJGdiXnGOH/cqfMVGL9/NIFxXkv5BOouqyp3fw\n2MPzu/RwvD09t6CGNWtLXMsQRYlGWuGpE7P/LB6adc8JwP+gc2vN4EvLPfNT\n0D2p8L1K9wCaDF+if4ggIgPpQm2y9MAhas8XlquyeMGEgsHaZl8jUvsppX3S\nPBHbmXp4N3/68lGpzMBfmTGYmF7qVdJkOdGQCalr/PN2lprwx53KFtwtByw5\nWjfbdb6X76sBbYukgzmbIE4rvdn3GYxZO+hd7FK6+VOBl8D1xyHo4zbpd6Fx\n7zGgwUfEl5sPWxp6Nw1CFRtokmwu2xpNVEDdwlIp6lkcSCL+hbv3NbhL3P2m\nQn7e8oTaVWojrIA1cGs2DVgbn3Y8W+wUwybahBGDdmjxAxc/QUC8TUmDkn7C\nzZ7KowukLa74veJubswUYYwxLlJf+4Vwg23qzFZq9NvpbaVP1jmEaoU/zzPj\n7y/4\r\n=ZM2A\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":"8fb0caa37edc7034a33024e9dcfa6a416857b7bf","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.0.0-rc.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-rc.2_1540215793335_0.9335069458428686","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-rc.2","version":"4.0.0-rc.2"}