{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"38dc76e530a17c8806adfee31cf11b77e5891f42","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.2.0-alpha.5.tgz","fileCount":18,"integrity":"sha512-GbSKghPx3dUE7Ekd3gUA1on9enNdbRTbbac+PBq0znvlCOfYOAwU2T8YbTlfIVt4Xbiwr8IDsExLEKHVGlePZg==","signatures":[{"sig":"MEYCIQCqRvyQ5/fK/QyynvfL/b4u2Dsyw1x/7FpV5ZhfL8l5MAIhAKolQ+8ntDUncxD22rfR2JxsF1Yh9WcBkPQE75dXRo6j","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\nwsFcBAEBCAAQBQJcGmz3CRA9TVsSAnZWagAAjsoQAKObiNZ6zWhXAayhm+A1\nmpnoUqT8kJ4yug4pkGm+SgfnRMH4P/SNYkmR8OjYQCEqaBC2dIulHSlfiib6\n6jQae2v7vA7CHhskBmz+jHjdGULPBtYx5vfOibIFhCRi3eMF83PPmbixEg1m\nskYqfZMmOVc5yRBuYnOpkaQtJuujw1BzS6puxkYwDg6s7LogHO+MpSxMBXeM\nnJMPPvbnDKq6dKQN92Fb5eJu0iaiu/V7RQ0djAtFqjx5sOhIeslZ+SRgHEx5\noa6iRnC2nJTvynwVoVW50YRAKNHCiJSPEpPnjA6g/S4qyCcP6RG8iMdtrfW/\nt8rU27HHBV4PsAd8C4eg6qToJrbiWkF5urTj0+vsW4tWgJhVVbKaEBHdPctu\nquHoIbiCs2K/tVlk8aeDzjRqRYnuha6PHKvRfrY37UdUiOouL/ym3vm0q7g+\nVqBArDuRaAthO+QAKt5oK3qRi+3l6ZP75dh3T5oSeKg9Llm14vGXuC06ZIZL\nhX984SfaFF4ZpML2JyUqAgjYxj3rOg/Rg5FjOMErGfId5x0unXYq4m8aF0jR\neoWJy4mqyTTPb9DWgCnLIkEix/zdDUN/gmbuQJ6gNPJbMQSRI+GSGKoN5RSs\nL4SWLaGsWnXXqSmX5WewMIaTo8OeYfHnQv2DAf+ekQuxxbNEU4wHiq9YizK9\nhY+C\r\n=/+rn\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":"fd600487eb3d295b22c3b32ba659f9b3ce7ef3e8","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.5"},"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.5_1545235702467_0.4483559105367172","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.2.0-alpha.5","version":"4.2.0-alpha.5"}