{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"8180c5916623134bec8f5f075c6751406d248ab8","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.1.0-alpha.29.tgz","fileCount":29,"integrity":"sha512-2Z9OpVJvAMOowQDlSGtZyKmj5JTvipay1Mpb732jLSEGjW8Kujb2e7ITksOIfUcSavImJpSyQuAxTGvfhXCX9g==","signatures":[{"sig":"MEQCICVgHTft+HrCLzQYU+fHvqf+uWNoDf+yaj/VxazepPz9AiAV8U/5SEXRQ+PVi2CkB6IVFf4nkIqqwnWA3N6VqiieJw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":190780,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJctuSaCRA9TVsSAnZWagAAg30P/R4zD5GgWsKzfUqgAJ0j\nqhD324cU6FrI6jeM9pjJlo22QsrfyVquznthBE6DQX6YJLHcNyYUmYD48f7J\n7x8f3pKRmB2EopE2DBQottPm6WfgyS95HVH3MaYzrQNdRlITawAw4RZc6MWr\n+VhS6uhQVSdur0nA/ZAsnE6iQuAL9a/S7GZ8cY95wwHeON0Sw37E37XdRmav\nDuPbWXi+BmI/dhnigtEGDxuk/dWP0Tvhyw2EXOivolMog2GYU/FQSjuaiSWN\nCICejmfBWHt/1Ea85M9SHl19Y6BUgd0eb2yXfBtvI++gLVCvzFVAQUMbBso6\n3IbnMSUhKTZxX6C7nrxWa1/6WzjHnaCx6OOJ62UFH2c9f0QQr0fY1E5zV7jy\n2+qn0asIobBcqqpV3lzLADBNCSQLdTgPll/2/VakWkw9v2jTWvdkoPfT9zXU\n5OoJKf2QNIQp6uCTvh9rBUWlzNUAGopi7vwFfvf8016rU89amP25VZgCZx5W\nBGIxdi/IHG/iTOnbKPkGcsyRwz7PDpBeljKdDIr2wwo680N/r+Du0IpsIckc\nsjGRdvG9slBxE6LXFRva0oFTnCZ2R0uYQbm/R1krtQmgHc1hGaPJHQBALKfA\npPD/SRkS9r7LF0z5Gj0Aw1Jr8Kgymbiv+a3cGkmm71nwAyLnZCAdDS+ENnSs\nblUO\r\n=N9lQ\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)\n  .add('with some emoji', () => ({\n    components: { MyButton },\n    template: '<my-button>😀 😎 👍 💯</my-button>'\n  }), {\n    notes: 'A very simple example of addon notes',\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 notes from './someMarkdownText.md';\n\nstoriesOf('Component', module).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","gitHead":"93978131030d52c821db049a3891402949a8435f","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.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":"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":{"core-js":"^2.6.5","prop-types":"^15.7.2","@storybook/api":"5.1.0-alpha.29","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.1.0-alpha.29","@storybook/theming":"5.1.0-alpha.29","@storybook/components":"5.1.0-alpha.29","@storybook/core-events":"5.1.0-alpha.29","@storybook/client-logger":"5.1.0-alpha.29"},"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-alpha.29_1555489945796_0.047557445346853466","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.1.0-alpha.29","version":"5.1.0-alpha.29"}