{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"d29254a6b432cc7d31a4d4578712667cd1ec6804","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.0.0-alpha.11.tgz","fileCount":25,"integrity":"sha512-IF+nTf0jLd2PDvfKqa3iLkqNlaqAPNbIrZpCOeTQa1WGprtbRE3Ieh9AehJn2eBXitYgIgkSOcw+Iuk+/HjAKQ==","signatures":[{"sig":"MEUCIHOywI+DohGXp0ihyCyGqLy6o6tsujQ4BqvC4GPstzt2AiEAs7TGn7SvD2Lxla6WRGCDRMXqPkDyUHW1SjymmPeOv+s=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":183092,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcU0F2CRA9TVsSAnZWagAAe34P/iWVT6b7UL1j9kRG/x+3\nwhYE0FBeXF6esxcrg0PpOEwh65fxWMX46hPvUK+A7Eqi4c9651Z1nF8LIhOS\nWgjnJZpJdCRVsXQ8yETQHJQ8Ouhwg1M6Rzq5LVykCsrrSYV9ni1h1m3MjrvL\nB8W09ORiZU7yZi/l9KvUV+tFqfZoFcgfEsKAV3ycoY9GHvy7gMmO632kzOTA\nLyjbH7FRZGuZ7oWfFMBQ8R91WW/L4I9h0SF2GKf063cdZGD+Y3cR78TjpW4v\nwfa8Sd3GrDZCfAj/XbgnF8ZK96in91audT9eixNyM1YUPZnzXgTOA1znQ7EN\n+TPI8CiUg5L+ZXUWGTvT/OYz6pszRRjydor4gxHMaJMkmoBpHTBJ3TC8KmLj\nY8/pR6dk0U4ZBEXlL4ROANddhy3/A2YgkM5iYOZmCCKZHOn4BzKBEHdgF3ys\nR08m2bAs/PhlghAHctJWF95RkYCjfztnLwh1aMHfM2o0ByuwKe/s7mmZRETy\nBD37uGfJbNU76J04pmSn3508yV1Ifa6GWCYClFvyhfZo/kqK7+OOg9rG/NAI\nrs8B67PDSd3MX6FDEm0WL3oseFdB079BoMz6NUBAVKwBwS8zXU0K32vvdvpC\nMjbuAyrVlZUPGVPGDvEpLAyj44m+hQcqZ6/YB6wtzVAUaoCz2iDae+2qxwRL\n7hPF\r\n=wdZi\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\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 />, {\n    notes: 'A very simple example of addon notes',\n  });\n```\n\n#### Using Markdown\n\nTo use markdown in your notes is supported, storybook will load markdown as raw by default.\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport Component from './Component';\nimport notes from './someMarkdownText.md';\n\nstoriesOf('Component', module)\n  .add('With Markdown', () => <Component />, { notes });\n```\n\n### Giphy\n\nWhen using markdown, you can also embed gifs from Giphy into your markdown. Currently, the value `gif` of the gif prop is used to search and return the first result returned by Giphy.\n\n```md\n# Title\n\n<Giphy gif='cheese' />\n```\n\n","gitHead":"6ecf42b4e75b646edb1df40ab7c306288c46387c","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":"git+https://github.com/storybooks/storybook.git","type":"git"},"_npmVersion":"lerna/3.10.7/node@v8.11.2+x64 (darwin)","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"}],"_nodeVersion":"8.11.2","dependencies":{"prop-types":"^15.6.2","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.0","@storybook/addons":"5.0.0-alpha.11","@storybook/theming":"5.0.0-alpha.11","@storybook/components":"5.0.0-alpha.11","@storybook/core-events":"5.0.0-alpha.11","@storybook/client-logger":"5.0.0-alpha.11"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/prop-types":"^15.5.7","@types/webpack-env":"^1.13.6","@types/util-deprecate":"^1.0.0"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_5.0.0-alpha.11_1548960116424_0.9535035500748434","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.0.0-alpha.11","version":"5.0.0-alpha.11"}