{"bugs":{"url":"https://github.com/storybookjs/storybook/issues"},"dist":{"shasum":"05a6e5a1b85bac018110b84937ee61a428945a0e","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.3.0-alpha.46.tgz","fileCount":21,"integrity":"sha512-KYRtNqbemMLOFUV7PO1bz2pFFoyjEXQzBOZUb1A3R2YkRKjbGZyVPwq9rtCkjqhD4zHzMThx2MGM3WX7tMyTlg==","signatures":[{"sig":"MEUCIH8VdO9xpBdLsuYD6E4AGCEo4c7k7Quy8ypAKkaWyTvwAiEAwMSIJaV8HjTYuD84uQssUJSJ70n4qBvvAmMogjQJGs8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":125584,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzx7JCRA9TVsSAnZWagAAHwQP/0uCsUG6HjKhNIaArlEN\nF0maTd1dQqneQIu/WqhOPqD4c40tBWf9Pus0IjQInl8m6H8LNkJS+RvMtPoT\nIe9jZrNJh+oMWSEc2Eas4r47WHGfRQcaD4KL5EtvCZnhY/GeM1Dmv63ORKEM\n3ccnQo4P4K8kr8u07ANwOe+J3aVYV0N/KAXlJiDUpsxsal0qGgmZ3Wi6ju9M\nMtGtydOKAIDLjrCXTZPGZGW987/xvUW3YXqZhRVCOmIVpF9/3RbC2gokJcvk\nYdnx5dMeOx3HGbwa97mF9skysNkfRPtn+zvPQu0+hdG7uFy5PUohDzE/7YBl\n/YnalolA8AbiWdjvsle0kJsZ6suHcej71w3OauFNibyFbwxvN/tAtsohZdP0\nKVAP6SbiLCBFIiR/ggajJjwdJyeOgy1hAQpq+Ozzt1HVapUVQ2aWAO1B5d6o\nKhYx3t4HzYoThc7SdwkKwlR2VJh7KqU6V2GtQhYdT2ccxkzS7mjrp1rMjs5H\nYWt7AeII7B0ZeKUV6IggkGyvOHJ0NA3Mh4S8H/KBq7DPY0c/FJgeCNs5oU61\nejQPURyMdToGNGZdKCXKZFjVTP93pyKVRAnUDLA64y8cZ5UnXMECK+ASI3sR\n4GpEuzyfQO7AW1G0vtlTmPlPQGQY9xzoO1yLA03FoEW9mgcTMemOG8fiMsjB\n0QdC\r\n=vpI4\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/storybookjs/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/storybookjs/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: 'An 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: 'An example of addon notes',\n  }\n);\n```\n\n### With Angular\n\n```js\nimport { storiesOf } from '@storybook/vue';\n\nimport { ButtonComponent } from './button.component';\n\nstoriesOf('Button', module).add(\n  'with some emoji',\n  () => ({\n    component: ButtonComponent,\n    props: {\n      text: '😀 😎 👍 💯'\n    }\n  }),\n  {\n    notes: 'An  example of addon notes',\n  }\n);\n```\n\n### Upgrading to CSF Format\n\nAdd `notes` to the `parameters` object:\n\n```js\nexport default {\n  parameters: {\n    notes: 'My 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 `cheese` of the query prop is used to search and return the first result returned by Giphy.\n\n```md\n# Title\n\n<Giphy query='cheese' />\n```\n\n## Multiple Notes Sections\n\nIf you need to display different notes for different consumers of your storybook (e.g design, developers), you can configure multiple notes pages. The following will render a tab with unique notes for both `Introduction` and `Design`.\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport Component from './Component';\nimport intro from './intro.md';\nimport design from './design.md';\n\nstoriesOf('Component', module).add('With Markdown', () => <Component />, {\n  notes: { Introduction: intro, 'Design Notes': design },\n});\n```\n","gitHead":"431322bbd9c7232984626283208ae890eeb1b8ec","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybookjs/storybook/tree/master/addons/notes","keywords":["addon","notes","storybook"],"repository":{"url":"git+https://github.com/storybookjs/storybook.git","type":"git","directory":"addons/notes"},"_npmVersion":"lerna/3.18.3/node@v10.16.3+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":"kylesuss","email":"susskyle@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":"10.16.3","dependencies":{"global":"^4.3.2","core-js":"^3.0.1","prop-types":"^15.7.2","memoizerific":"^1.11.3","@storybook/api":"5.3.0-alpha.46","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.10.3","@storybook/addons":"5.3.0-alpha.46","@storybook/router":"5.3.0-alpha.46","@storybook/theming":"5.3.0-alpha.46","@storybook/components":"5.3.0-alpha.46","@storybook/core-events":"5.3.0-alpha.46","@storybook/client-logger":"5.3.0-alpha.46"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/prop-types":"^15.5.9","@types/webpack-env":"^1.14.0","@types/util-deprecate":"^1.0.0"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_5.3.0-alpha.46_1573854920728_0.6248809044395478","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.3.0-alpha.46","version":"5.3.0-alpha.46"}