{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"fc33828d18b48cc9825385accd69035a4a310347","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.20.tgz","fileCount":13,"integrity":"sha512-Ym95SCBKLiMVDHvRhiRFiJByolouG2zMqV8HopV8GQiCMzty99vj1QUCNAqnlQqg72MqT10UTsb2by9ANt/oJg==","signatures":[{"sig":"MEQCIF6ggieLgsE2Pqd8ZKmn1ypyBe5WFWxhujuHztdoor2BAiBOmxq/2FqaCTCkg+51xzjo92Vgp8e+eBq85VJpBKXfhQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178340,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbicmsCRA9TVsSAnZWagAA9tUQAKE0kSdAMACt+KMMVYF8\nj5IzFweSb2kjeEMxjSC1HWd4cBqQ088mxoSLcwdJ1oTv3UvzRZgl+MsG6zsk\nLCDdQbb/pSfgAo0FEKmV57fuesDlJ4vbNBfsGF/ju5+BhDyrCT9XPug/E9qQ\nP5cmbciQw0xQTvgCwDZqwBNeWF1zTv3mfxSDUqn8Ou1SyYtaKHsEEVh2VF+B\nCJQ/tQk6/WbD6zGx+WZcEaTOH8h0Rg6FXDIkBjD3ajni9pEyVbSqSn1b2ABe\nUtk70NmIXvF1X4KzkmKUvWv2G1F6cFYuYE+RoQ+mi8mTkqJ3Rab4Iwusa1pb\no+MCHFxzGQyxYaQ8abaDOpEhcllb/Ul9rYtWkG9vZxKFjJ5ftmjPsuQ5D6Qr\n4UI0wrOaSMXIr9GAUH+28/hPkRTs95aRE5H0fKYp0asx+WjYIrOguOIWY+fU\n/F0Y+lwibei5P2CXyML6cFA6iq64FJgnZjJmK8DRtF72YB7R6bIM400N/Vc1\na9c2Szxx2MAoH6+woAoLXD5a+aq7T9+DxtyKgde9boPsxpDYOZ9Ym33TNj+/\nezHRfaXSCJMe1lHx+EKSaAqP6DWzK2yo7+D7aNRPe/M8haICPidfX7yh6Fvf\nvI6HADRYksgfp/IxlZz0v5vpSCqPf81XOCfHfHGTKYXa4w/gxwmeNx2f0yQ9\nwF4t\r\n=6kYj\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","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybooks/storybook#readme","keywords":["addon","notes","storybook"],"repository":{"url":"git+https://github.com/storybooks/storybook.git","type":"git"},"_npmVersion":"5.1.0","description":"Write notes for your Storybook stories.","directories":{},"jsnext:main":"src/index.js","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"arunoda","email":"arunoda.susiripala@gmail.com"},{"name":"danielduan","email":"dduan@yahoo.com"},{"name":"hypnosphi","email":"talpa@yandex.ru"},{"name":"igor-dv","email":"davydkin.igor@gmail.com"},{"name":"mnmtanish","email":"mnmtanish@gmail.com"},{"name":"ndelangen","email":"ndelangen@me.com"},{"name":"shilman","email":"michael@lab80.co"},{"name":"tvs","email":"teije-vs@hotmail.com"},{"name":"usulpro","email":"regx@usul.su"}],"_nodeVersion":"8.11.2","dependencies":{"marked":"^0.5.0","prop-types":"^15.6.2","@emotion/styled":"0.10.5","@storybook/addons":"4.0.0-alpha.20"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.20_1535756715416_0.5164459633395246","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.20","version":"4.0.0-alpha.20"}