{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"0681e94ef16352da9d0f3e875f1cb9a8bb9e32de","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.2.0-alpha.13.tgz","fileCount":29,"integrity":"sha512-SEdM4hKpCY7MAb45wIzTUvr5N9o4E+i5UOg/oP7GpaZKbh1meF9PAA01sTbbcc6mK/iADttMpYHCpI/TqjksMg==","signatures":[{"sig":"MEYCIQD33hi4ap1o9hKTsKIM4u7X9olkgNGTo2ZqGsSGWtuEIwIhAM73X+ta73QgtqiWapuNemwEe1oWuD15M+3HLdPdjQCR","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":194813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc6IlOCRA9TVsSAnZWagAAKk0QAIfCdR1orqyVfqg4UbGS\ncuI6Y5eTWj7qid/Enb3yXDtoYF1+FsvJLGirHVsl+2hYBuZmIFc1FdsrVzLV\nSCewBPZjOz/921w4ByJo0fEvVZdjAGWxin+itCU1GPcVHUUTAsbbyEP0TWW6\nsCKnRLhZR4vxVK5Eo6CYt9iXRG9ULY96ubj/M1URrw0KjYnChJzSo2yhiZN3\n6Z9crYrA86qM9wKCh3NBLWamkE8ySgSDGmeG2jp9O007RV8PB/j6G737Xeu2\np2zkpxgY7hnhjvQeq8K+TfD9Lo+941KsQwaeEqGBNEmglY95VW2BaYrmilEe\nt0PEdVxbvnvDpANktT/bhzexfPesginVoclxutAIeDloxuGecdtKgsoD+Yqk\ntVavwvkm+43LnYtBFITx6nsyU6g3GukqwV+xfsc2sV1i0qlNPagVM4OkuR5u\n/c77tsREqmLq96FPu+BtF7YWDLIQ223hLd4zI8Z/xgRIBTuphAVJOm5w/P4+\ny1DzJN062MpInpTckJ0aXnitviRbuqNkw1q8lmgw1evAKEtR+yJttIjGPaNf\nLkjNj5Z0RxPIAaR2dKHLA1N+vFe0/A76fLvtx/+ZFdL/FWmZORaaGDDXNzHc\nchfH921MVKf2KmL17ySlPsgsolElUI8m3oRBOdaZEVo++o+F2w/FBe3LO1ex\nwU9r\r\n=Lrio\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\n// register the notes addon as a tab\nimport '@storybook/addon-notes/register';\n// or register the notes addon as a panel. Only one can be used!\nimport '@storybook/addon-notes/register-panel';\n```\n\nNow, you can use the `notes` parameter to add a note to each story.\n\n### With React\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 example of addon notes',\n});\n```\n\n### With Vue\n\n```js\nimport { storiesOf } from '@storybook/vue';\n\nimport MyButton from './MyButton.vue';\n\nstoriesOf('MyButton', module).add(\n  'with some emoji',\n  () => ({\n    components: { MyButton },\n    template: '<my-button>😀 😎 👍 💯</my-button>',\n  }),\n  {\n    notes: 'A very simple example of addon notes',\n  }\n);\n```\n\n## Using Markdown\n\nUsing 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 markdownNotes from './someMarkdownText.md';\n\nstoriesOf('Component', module).add('With Markdown', () => <Component />, {\n  notes: { markdown: markdownNotes },\n});\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","gitHead":"66371e3f68686434bf0683daa6e21f9cfbad7e2a","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","directory":"addons/notes"},"_npmVersion":"lerna/3.14.1/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":"domyen","email":"dom@hichroma.com"},{"name":"gongreg","email":"gytis.vinclovas@gmail.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":{"global":"^4.3.2","core-js":"^3.0.1","prop-types":"^15.7.2","@storybook/api":"5.2.0-alpha.13","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.2.0-alpha.13","@storybook/router":"5.2.0-alpha.13","@storybook/theming":"5.2.0-alpha.13","@storybook/components":"5.2.0-alpha.13","@storybook/core-events":"5.2.0-alpha.13","@storybook/client-logger":"5.2.0-alpha.13"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/prop-types":"^15.5.9","@types/webpack-env":"^1.13.7","@types/util-deprecate":"^1.0.0"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_5.2.0-alpha.13_1558743373986_0.36942016114490994","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.2.0-alpha.13","version":"5.2.0-alpha.13"}