{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"6624b64e6aab99e7d523f2e54df9d2baa9c8f352","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.2.0-alpha.4.tgz","fileCount":18,"integrity":"sha512-02ysxAAXy5DZJ3KKooYc6riEwhnzXpxcc0WLGukadLTKhUKSEscNsf2KcYfu5Evfxc7P1oOIGjwPYl9QdaiEBQ==","signatures":[{"sig":"MEQCIEnxgYOL5u6i+90oVx8TG3pajVbi1aa4VVKd3uKi0aUQAiABTR5jw/DrKFefoslsXl6d5FAmjv4GSWNfRw7napNmQA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":179329,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcGfJYCRA9TVsSAnZWagAAyOYP/j+RpndHRRcQ8tI9HBUQ\n2VUTzlPbN8Uf9DlGTly7RPOH1gx++EuZWyZHka+2cBq5vvWRyYNRhNiJPLF/\n1/we1RncXrI76asAEw11z5Vub+n/aeQoki3GcDSMIzKpqvR/cd0+MbBL+uuV\nKTLsD50HXevMo+zq9Xn2igOv3k5HT2XbEkbjbxG/24A6N1wrkBiAuwOJLgp/\n52ykXQkeoQStmh5XG5SwuzRTbQs83QjlyKd/dAzQjyUBkS0I6nwRdPmrjjy7\nVEUGj7c+MvBrvsklA3xnD62b4MWL0VOUzIiJfQmfbp9yWDYQJsT1Fv4CDedq\nJoQM7/i9/WVWpld4+tmQFyaE/Oql7kxMt5DWKuYxJJ8uwrb1E4LXpHlIp6nc\nn2AJizpaBHI5DPUcGfuF4kEHhOW0ql/WQf7u3dXxwju8oaJw95u3mb/11imr\nj7wowm8irNsjDsOqQULh+Z+E+6BfXjRTDwwHy/sGFi7KSJ6G9J3ZLMjlIFJK\n6HmnSVnO1FaGssjIyf5/sceUOeG1DKR9UsLZg3zns+3Aad37RhgGcQVqmTCO\nSssIbQdmKZiCz1s9x0l6pmEt+T4+4Way/xh8kMOJM9WD4i9Q40MJz6qAgMj2\nczi4HGIBXqFTOCusn4BHTiALVf9gQbYt9XsPxRzbU6/1v82IDXgggC/A+K3w\nE12l\r\n=iup9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/public_api.js","name":"@storybook/addon-notes","types":"dist/public_api.d.ts","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":"a5b4e89e4cb2e2029d0ac881aca6b19a454b1821","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/public_api.ts","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@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.2","core-js":"^2.5.7","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.2.0-alpha.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/marked":"^0.5.0","@types/prop-types":"^15.5.7"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.2.0-alpha.4_1545204312371_0.13533951688629675","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.2.0-alpha.4","version":"4.2.0-alpha.4"}