{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"207cf0e44ade4e11a74dbab3724cf0988cad627b","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.1.0-alpha.33.tgz","fileCount":29,"integrity":"sha512-nXHMR8RhQPzmgajLx2iUQTiaoW9gLVguS1CujlUoXZsH1crJ+H7xP7LqEFASTATnnqvpFNUHvLQgRXmx4C9DSg==","signatures":[{"sig":"MEUCIQCpiB9ZdCAwsLL65y3VWoZmNgK/qvRGR+eJKXASGc9S5AIgTKdephqwD5GvmdEk4pebp5KtZGG5VQ9Y9kfE7Gndclw=","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\nwsFcBAEBCAAQBQJcvrD8CRA9TVsSAnZWagAAGDQP/AtccXnP2YZ8u/To5Nl5\ncKPpvEJifYVH92E7JE9PIl7IxdzcNBSNwbNFKlFMLT7UCLz14kg/lVv2L1Gm\nPeZcXv0GYSLCs0QmAz0ZwfrLCD8e27/0s+fh1wC8Dmm/1EKAreHB3r4UO9vZ\nqsuepvrud+IQkaDR5GLlbqgTcj7S3yCXctekCtp21gOv9SFu0E3kSiCI218N\nfqgDcIgWiJaXDDfsUzB/N/PtUhdB63Vib23kB41O9TB/ymN/D2Hu/qJc5N5O\nXoyv8opjWpp7s6BZYN2Ics6t9sOtzkik96GK6Q04e+WcB8vvyokCctSd+2PA\nEH/0QWyBqcXbgiLQvokCB1oiZCGGIeywg1nOqTBVvNqhKXYJmfgW0T6Va4Ck\n3ZbAD5D8yVk0hARZBt+LZztdgE7evxyK08Hf3mFnukyEq1ujRq4GccPO0CHL\nm8O4ZEhy7pOEwXYJajRSqw95k1xJQb4ZiBVuRNhGcSXbJEXr5Mc2IyI0E3cC\nXjY3lAygzO9OdA4NM89Ux0MmNDYdyo/9yDIBhIULlL8gb8mJK1/HwQd8TKDo\ng953Lzf26Nbk8QB0hnzMnZW1PCQUKEGMk7Upe2elW5NABRMV3enwCWiBn+yy\nH17BVi9V5P66DZini9A7lF0Kode5np9Z68DPVxIZD695I+tY2v5BjVzqUB69\nGtDp\r\n=MHJZ\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":"23268e4fecfd76db92e85b270b689368fccf8caa","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.33","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.1.0-alpha.33","@storybook/theming":"5.1.0-alpha.33","@storybook/components":"5.1.0-alpha.33","@storybook/core-events":"5.1.0-alpha.33","@storybook/client-logger":"5.1.0-alpha.33"},"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.33_1556001020175_0.20516522792429992","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.1.0-alpha.33","version":"5.1.0-alpha.33"}