{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"426ffc3b76bc8bc2e94169a6db05d856c5e94243","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.1.0-alpha.1.tgz","fileCount":13,"integrity":"sha512-187Tg4Bqg0/zgr3yEFC3ElHJWLkM3ai+ookdlxsgHiIfg3yOEcoBdeSZi+t0o6MdIKlmzUZR/HuLHDoLTEe2xQ==","signatures":[{"sig":"MEUCIQDnxvAyja8rV0CvMPGvyUqFehNHFrBWU8SXb890TY+J6AIgZ869gYQOUJh6togq3iBob4wNCGgMLOaxd8UlXQThhGk=","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\nwsFcBAEBCAAQBQJb4VyUCRA9TVsSAnZWagAATb4P/1bVR4e2BhwutLIkEeMh\n1liqEFJu8XPRSsNGTzdjuPOzhBDMmP0vo7mrW9XF/tlD5gX2c0rZxe/2xoNR\nSJRr/HkjxRrOSS/yq1GuPgI0yCo3Rjzd8cKAzo9gRb0Pys2bnzBYNkd3hZHS\nXOJEHyRftrKQ4JCGvi07y5czo6GgtIKT1pHUrs9fzFsRbnSGEkCvGGvmVmZm\nMf1h6cPTNZwU+Dz1XKjznXH24qrYdT5OgUGERc+E9CEzLmQt9/IK01mfn6Fo\nckRfr+E2kl8CoBdZWuq6KCdy+39Uikx+0qJOf2ckbYyyRnVTLYrx6KCW1D99\nXsmcJFvzewPmH5zQ/jlDt4WIwR7nROAPZumV8Uv/SeMECiU7izte8XzlNiMg\nOtHjkr0AZo3jS4f+s6fVmDPfR6ob6etCpHvh6Ss6nfrQdN985Eq+cAhRJwv9\n6ROLz0R3pYgVAmGuqfHoDsTybZSjwEFhOKy7X9N1LIYM3zblpMRskzrbNcf6\nnYaGPEfkCrimoFpdQOL0KeTGODqaEjWElKpl2/+ax4gOA26E/TokX6HCKcYe\npYhpxiur0XBxhuaKSC7Y7263iml+LwhOW3kw3vf33Kx76+jo/CMzu61KAIC9\nuCNmFNuBnuN29vGy+zi/PkiRaB5+SCGg214r4MqqtN96LoSXc9IIAAhyTPk/\nze7R\r\n=ZhQN\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":"253a667e68bac7dee4d97a6bcca020b7d05617e6","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.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.1.0-alpha.1_1541495956160_0.6083789460400966","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.1.0-alpha.1","version":"4.1.0-alpha.1"}