{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"c4464452ffc78db0c61bb453516fa221379d3ec2","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.1.0-alpha.26.tgz","fileCount":29,"integrity":"sha512-NDgvm48I8LqQaPSStbqeGyVp4e7RXt/ZFizLOn65OxnzMpN8RlSCnzcrk9hBqa86Ieb1bw2oy4nz1iJsGHPFSQ==","signatures":[{"sig":"MEUCIGP0S89D1bb4Yszo5AfJOzc8ErGXfE6oTBiyrllUQQnDAiEAlY6xw1MC4vpbZsmX2fs0mP0FcxzPuto/EA2arbWkrGM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":191004,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcsTYBCRA9TVsSAnZWagAAMg8P/13zwg1ZHoYv4qelLZx9\n8KITAtmPrqVhvgK12ywqwYUz+FjS/7L3U+sNpGYnV36Nx1rVednktaOy+Hrt\nP3DMRxUChSedZUWRQ/ObMzF4chz1k4JnNpmPur2rlwF1fbWewY8iJe8LHWcl\nw7nTRd0TFmrl6rALExJ9RA7jOCcbHMmp/D40gegR2b9EVwttgh/rFZD8holR\nBenxNGROkDI3GvwsR4cyWs83MbHSo9Lpy3fY/+vALKHbXcoAXr8fQbTR2UiW\n4tDu6R1B+6PY20yu/zWbDZo4zAWe73Rzn71LYVemmzXzRJCNWaf7U7wU0W9V\njttrm+QO1Two/7jHJ6hTZYZqKdzJrWHJnB3/0XCMv3V3d964tSMhKJ6WUhhk\n7cOK+/p1Sitb2Jbsu7cwi2vqbNF4Lb/O2jduJwNu7HiWh7k9+jyFeg/xm15r\ntTDN+OYIQ3KGTaCNDw2G9U99yK2b6nyW6PjURwVDPiSkrvtSdMbGRg0wYAMx\neAQovh7Cu3kr6lMrsJiLawr2flbQPe4sgzw42VFahjfM32rGOKSRXiXDialG\nQrT0/ctBDDUdqDcnZC8WDhFaxO5UklDFHQyO1MKdT7CeyC1BZfxdbbsnPGAW\ngGSjY1E1p0gT5DlQxHOryrAFYK31zc/6lHCHxQHtOe9A4etJ/RfGjIO1bu0f\nj2pS\r\n=MHcH\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":"17b8fe98b908b8b6923e6d97c0689b25bd1bca86","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.26","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.1.0-alpha.26","@storybook/theming":"5.1.0-alpha.26","@storybook/components":"5.1.0-alpha.26","@storybook/core-events":"5.1.0-alpha.26","@storybook/client-logger":"5.1.0-alpha.26"},"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.26_1555117567737_0.3856590135850204","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.1.0-alpha.26","version":"5.1.0-alpha.26"}