{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"3030f1cdc383ba0efbf061a75ac4c96df6cf781d","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-rc.1.tgz","fileCount":13,"integrity":"sha512-h/IB2eAgqtAjhBVuPCWLXl6+oKa6FyCJqbvNK6iywT+jYP5rFBnmB080VgQ8NX15ucROHhnzS1564v5GWkpqBw==","signatures":[{"sig":"MEUCICqSmap8BH6O+NRbOpB1P3hnNEWqTRuDZfgzr1FLPULgAiEA3un7fXn62j0ENfOiTbf9uPTPb0TqI2MmJsZCMa/yFRw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178530,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbx+iLCRA9TVsSAnZWagAAR2wP/1vn7uON+35pjnRk99uQ\niJGdQge/U+DN8Qp8/apuzDkumKC4WZhU6ZMyxLlU+qnGXzkbAZ1RhENEK8Du\nkfkVL1fwmDq1VQC6jUDrtesRGok10w8L63U2oD9BXVveUnlgPjpilIJKW9cQ\nqffjzzNrnZpbxaWc4yaQ+Se5Ci/Otpbmmu+8W3e2yOng07E2iPtfk9gbVGr7\ns3uVQ9/k8sMvrIWrqgw3Z5+cAsvJ8hFy3KqMZH+ZE9sFiCJrz66xPiMAPKIW\nbS6yHf6ghyv8+gXudRJZWHtHT1qQFLS2oMOfM4NlOby2Ax4JP2jkYp7scFVh\n6M15VpMOl1g/1iQyKE0gbjbx1h0Pa6Mm8pQCbICCqK16kCNFkKaqBTmpHwMu\ngnsgZIMr663+Y6WekGYMVJlAcraK6/5cV70UTcj/wGo4U5fO7wXWDa3GlmfP\nw0BvTB6jBm/ix4/zJY9+ahhFpAiLipo+llpTa7E0N6AHzJ9TU+5fvyKwN6t7\n9bsrR9k4agBFvqM8NybbthVBs+BqIzhB9Ai3DKNv8Ogjn6pqOetKl8robHRR\nUw5AYI0CF1cDZSxzjQweEtHUjvbm9rIm9LhojTWRnO86uyjDCV3zjQih5Z9S\nFwcGR2hsZgcp1/X+QjNhzi1qHttVFDPHzuVxxUFC5ZAoSrLvOa4rGj6nEt5K\n8Atx\r\n=hrAm\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**NOTE: Documentation on master branch is for alpha version, stable release is on [release/3.4](https://github.com/storybooks/storybook/tree/release/3.4/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)\n  .add('with some emoji', () => <Component />, { notes: 'A very simple component' });\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(\n  'With Markdown',\n  () => <Component />,\n  { notes: { markdown: someMarkdownText } }\n);\n```\n","gitHead":"46d89b3e617c500235c68e6d33067c2838c55489","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.0.0-rc.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-rc.1_1539827850658_0.8825695144699011","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-rc.1","version":"4.0.0-rc.1"}