{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"f88c476d2a6c4c72f6884434fa7e6538dc5631fd","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.1.0-alpha.2.tgz","fileCount":13,"integrity":"sha512-iadrWYvF4At/z3c+ebgWR/u/RZ88CurmOWwLPkWaONfSSLzaA+6otUXzE1c7Q9XfegCDYyXvO5frr2+NDSpffA==","signatures":[{"sig":"MEUCIQDZM+EYYtIj6koB7KH5EBVYMHyP/2sts4nSBcaBOISXCgIgbnN3LCbXAQNAcXzp8K4LWTatew2t2VIW3DasgbJidXU=","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\nwsFcBAEBCAAQBQJb6rdoCRA9TVsSAnZWagAAztsP/2y/jWJ8hiqdMsmQvL3z\nTyOGXdIvOqDY48d+aGkm6m8q03BoDHbtUVUkFcXBP+XShC0DsOqMeg7VCm1c\nHWeq9WNVh+cOBazueolgMCDkQt2wKCAynZyOY0ZPdNHqUo71hZbcZsSVOjMg\nTtFPr29lgqvLQZm7ISI4tsZcQlJrzr5o/32LXoltj0y2+k/U7K05YaZvuSBY\nI5rxpaJ4PUgpPDO29jICjQ/B+6SWIszRTrkgbHjjXtOoGsepWqn9VBcIdklK\nGziWZTeaqvYvtdH3+scb3YT6iTknpdT7MqD9nqLbDEMcd9RoT5a1pxBzm2Ji\niJzw5t459LnndOIgQBy4QywO2hTie7UypPejYz9xZgBWylzLKQOl/V+4TL+5\ndakYcvt8i8kLWHs+rMQjBrfI8yHvb/8XaPY38CV4LKzdhvNpCv7A8ImEzl8F\ndJAFvQ+XOaG5KITNNM7XnZWmLDfwsOyjpbagv3OaGRRm3GQ7aSoyl+bPdk2p\ncY6SCK3YAQU6P2/4/cRF0xx9CV4dbsIkyLDYmGwxOEGmjwfyStZeixkV62DS\nx+zybxwac2Jr1YFLTn7X9Uy9eiElJqgf7FhE3SvMHsFU9hOzKfaa0PqNI2ut\nM0ClRe8WN0yoC4A5xiyPxAJ+lbC6h5qUd3jm87U5xdwgbsDd2UAs3l71WghY\n3dSE\r\n=RZvi\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":"cdb9e485eb85690368b1f698db9220ca7bc0298e","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.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.1.0-alpha.2_1542109031569_0.46626459108721496","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.1.0-alpha.2","version":"4.1.0-alpha.2"}