{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"993b2ba4ff4fd44e8d09bed3741e490e5a6d3edd","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.1.0-beta.1.tgz","fileCount":29,"integrity":"sha512-poN3aVXktbxgpddDogEr5lOk/RWagYLWPhxfrE3zH3x5BIONBrg5Wj4u2+9mErSvCvVJZQOD+g0FwRaHEZQCSA==","signatures":[{"sig":"MEQCIBz7IliooLe3d4RBPAz4b5x3m3nfszs8yGY16UOfhNTHAiAgfov9TwqrqercQyomhzmfzCeEx3RuTnFPHIBV/8+0Pw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":194797,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc3P0JCRA9TVsSAnZWagAA+vIQAISRs55KC1zIL0zvShgu\nsrcgA/l/oJcaQ0O7pBAd8AmGWyKZkzZIVten7zLG3VFJXJLbCwvl2S0TkK7N\nnQV0NwkMxMV9ySDnIURyN9yf4f+KcIZGClA2kQhXSfVsJxw3PIy6JHNN4vbm\nQY3UDr9Y0DNaLH15VnJMeNFYbiKMtjTPiiz5O0si/gNQ5/ncpCYGgNYqMLBt\n3U0UWIXArlW1nrmPTBz9XnNeLCsp14rj9RonBd23Muk8arSE0omi5OZ9Bi3h\n+l7ZZi9pEfuuveNmHkV5FOdNuLg5jrh8i9lD6q1kTiHl2wK1YH2jThj50kNq\nIyaAF2k7kh8urZGs7rBw3Mw7V/BcWLSVZdzfVvUOAVdGJX188sLMRthvqg8F\npFFAp49QzL7wgLUl0l25TcaABrsxsEIkjELnX7bkR4deT8gvGuXpODdcsBoc\nGFglY10wn6raCuAO3z+bofOkOKDgI0Nrro7ThETDynXENjbgju1d1cNheYrw\nBJHcZ73BGXyROg1bvcdowWJDbshidY0/iHuar1SAECxTfXVIapesMAYZbhJ0\n9eF5ridhily/vK2+0tRd+DFiT4FFRD3s3EgPsQjIVCItrej1mjKtmssR0rTZ\nLSakLsZE1gaB8VTRb9nvbi24TeCLx1mfypBNRk+pG3koEN9sBzfDdREqIcLd\nsFAI\r\n=XiHU\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":"e14539f7127f8dd8e4b9f10aa7d95fdecd86de2c","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"},{"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.1.0-beta.1","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.1.0-beta.1","@storybook/router":"5.1.0-beta.1","@storybook/theming":"5.1.0-beta.1","@storybook/components":"5.1.0-beta.1","@storybook/core-events":"5.1.0-beta.1","@storybook/client-logger":"5.1.0-beta.1"},"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.1.0-beta.1_1557986568539_0.3094099131931931","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.1.0-beta.1","version":"5.1.0-beta.1"}