{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"51ea2c7afcfb89e89603f6534270203a0b736800","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.2.0-alpha.9.tgz","fileCount":17,"integrity":"sha512-ZkaBcsw69mHwkj74W3+7N0x/QjTPC3pDwyQ/Sjqa5NWXX0lkcLbPH68VLs8YLUaroL/G73FX1we3/Q4VqEV09A==","signatures":[{"sig":"MEUCIQDO1EAXetf4M4agPWxECAVxfBFz7UAi/vL3HzIFL3fivAIgRUIdSclw/WvxIFc/pu2VS+2SrD3FHSfVu4il2Cx0P0k=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":176489,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcLuPhCRA9TVsSAnZWagAAQ70P+QEPojRsDWfDsrmJE30J\neX2kL8HzIiA2RMqFhsEsTOQ+l3xhCdFAC1x9xvt6dn98/U8PcS3SUNftOOIC\nxy6y58E2mJXj8DikJzq3vC9ezFGxI5xui3+ir6XXRcFufY5GEZwHXNP42/lc\n7JVxxvkZiFhOWqhPGD5RFmC/tnvblJw9zpXFM+laWvR7vyRRRnUIA4uZCCrI\nDUTsxOUlaEUDXswFr14DfiKJ4Ax5nbPWmOAZocimPz9XRce1g/0iAUsH3mcE\nM+K17ppqnAc+blfgZeskHEHL35rKkAfEuABcswMgK0TKt5DlRDrWs6hcFpxg\n1NTLUmWZ+MGdHDAyzpUPbbw/lpG+4EWGlCEWHIsHj0MaelEp5eueNMuUWcpj\nk4B2/bqdeeshdPgdqQXZb91Pzygjc94sMHluPaqcll3LtsRfInXyUsuYwX/Q\nEA9QZRU4t7FquPdtKSVJ9i29rzJ/cLjWKuHOCYnJIfoIPqa6Ht5ST16wlRgK\nBrPKifuaVuU5gH9qIacsG+lBPv9ABvQzIPg37SnHkXz802HHrny3vTn0Vbh+\nQDs1a9KhGBR6RoeiWCoUzESD0tMNm0BdJxkZM0uaebziknwvSZTT2VkajUl4\nxIYmrdlD1SxLtTzYpzN6sdfNR+XxZyX1lm8tdaKDFbqjy0ma5TKboa/UUUr3\n6Vjz\r\n=JuQJ\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":"ee0f498dba1b88b81b34b89bad13839d3b19e978","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":{},"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.9","@storybook/channels":"4.2.0-alpha.9"},"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.9_1546576864804_0.39890184033954124","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.2.0-alpha.9","version":"4.2.0-alpha.9"}