{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"57c543d0baf781f97408d2a396818e684e56dfbe","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.2.0-alpha.6.tgz","fileCount":29,"integrity":"sha512-NBc4ZSm7T2JqRDsDBv+pLHI9wzFUoYciezPaa6Nd63RxtlJZA3fivgno08NG8slH0IK0jm/vMaQgxP0OvsNKZg==","signatures":[{"sig":"MEYCIQCjx30w25/EgzMJYev5MPfcPudmB6j2w4Vd+ReLF8oLTgIhALyiq0TBfIIFG/kUofKVBhEpmNJkZIjZShY7HGbcR1K+","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":194805,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc2viQCRA9TVsSAnZWagAAnZUP/0aiD9SCtRc1deCSKyS1\ny3WUFFATniZtApw7DGyFLOk+km1x345BC7bKjeV0t9Gk0mQFZS/zjWNrFoqL\noZbEcz2Ys7MAMaFzHJ1cB+qst5MKQAhkPrBf2QCZL7+cU+uJmFHGIxuOdgxf\nP7YxZphgS7Lck32OktMHvM0qTTGokOd8AxctVyd0a9Ow+nPfkn3Cy+roKhk6\ny5xBvaCqH5ATGUPownwdGNhS2ghg2oVGfDJhq4XH8BhMR4KB4Y49biPt2R8x\nXPnI+1MjaE7E/CkP/oZo3pim6t3Z7ptUWMbaijLDMRneZeqSnr43pg2z2bnI\nn57x0Q11DRjCk1kCbiG5oFwBP1oXzL2JtBFVWKQPurjy5Vq6FqizpMb3cR/R\n3Kvl1OpufjxaEQyjSL3qa1OtCYD80yODPmdyG+QTFv3HApIKOhevAl2JLApb\nkKG8Py//bHLG2KHfQvYZya4sp17S0X+W0VatCnOJf0uWNKbH30TqtdRTzr0d\nF50tyWf9S3Xjrh8AhQSMWyLq9JpMTUMcZvibV36PFTD3aFIGHeJ7pKv8Ft+h\nqcSPN9/XJPOyNVE6Ho87bWQf2YapQ58VL7DqOKXbEY6b7c4ctg55c4k8fc6J\nshDMNTP9oK+up0gKLUEyFH8M2heCG7ifPSAsGcNl3y8FDSvG7Rlmo6aHrY1B\nML+U\r\n=kp2/\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":"c5f2a840108efe29c836272c8d1ce7d1510f8217","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.13.4/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"}],"_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.6","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.2.0-alpha.6","@storybook/router":"5.2.0-alpha.6","@storybook/theming":"5.2.0-alpha.6","@storybook/components":"5.2.0-alpha.6","@storybook/core-events":"5.2.0-alpha.6","@storybook/client-logger":"5.2.0-alpha.6"},"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.6_1557854352179_0.7010569860090843","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.2.0-alpha.6","version":"5.2.0-alpha.6"}