{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"c46b2b35af50146bb56c73726bbe53b07547084d","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.2.0-alpha.16.tgz","fileCount":29,"integrity":"sha512-RLLKad4KB9mJAPt646etFTtSs4QN6mgNEHbJkjW2Uf6ulspRBpkPE64uN/So8vFGQl+LRpcFLFjPSSJ3pQHH6w==","signatures":[{"sig":"MEUCIB+sqae8ELSBTFp+D/E1yA6spJhBxSjFzBZvP8BdyKpxAiEAnq0+xuzriujPg271FmiQh8AxmCFYZALKDYT0fgUSF6c=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":194813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc6i67CRA9TVsSAnZWagAANCQQAIGqPnGIV47ScCdjfGHa\nR0xrLKcTyRudzzl0I4oYv/SDJsB56fY8X6NOqeXF29EVdbXRfTChohTCP9+Q\nWme8J0wQ6SNtwQ3lQvkRh8E5kygfufa5jR4Racmiyuqt+WUDa/kOWZTBvpSe\nHSX+JIH7SC+U29dT+eqQQuwvuxhKIVT7mtmyK8c2KujdHXsKqRit6xco3XOf\nMne4ClCG5FHKNE1BE/Z2/Ep7OmRvmsS2l04v/iG5xnbYXPVZBBS+pMGesHOI\n+W/anfELC0R2KPfTI4SIr65oLc9hh7GhA798L11N+DR5kwtdtz68MEvVw9FU\nV3UGTZ38JpTjjHh5/DQoViyJynxmgAzQpXChOS2D1tPQaCEcKY7fD+kGftMM\nc2ChFrjrFZ7yOaTlgXFLy22X5NBqjXzcJdUVVrpGAkIOuE0gSybTcttxd+Cb\nvw5ZFWQq+jfJlJgsiS59HixGK1lUUcH0ggUFj7kFQbKQg3c/J1QsT0aF80NB\n3/EcwwPRwIw5ipFdmooCM951EZgKRg+BNirVKnwtYNbhjQVC8TqFe+mfAKbB\nqSETLcBoG2FiUr7p2EkNm+JXWsQow4TlpHeAyW6YceT2CPJv+g0cTskxUOCB\nfjQ6RzHuA9BIaT5GPXWm3mSoVBCgBKtOrF65CzNqyZrkT6LuZmd38QniY38o\nQ/rI\r\n=pW/0\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":"a618ed45a45a03d9691ba6ef0c931b0b8b2ae56f","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.14.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":"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.2.0-alpha.16","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.9.3","@storybook/addons":"5.2.0-alpha.16","@storybook/router":"5.2.0-alpha.16","@storybook/theming":"5.2.0-alpha.16","@storybook/components":"5.2.0-alpha.16","@storybook/core-events":"5.2.0-alpha.16","@storybook/client-logger":"5.2.0-alpha.16"},"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.2.0-alpha.16_1558851258632_0.6359167346704202","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.2.0-alpha.16","version":"5.2.0-alpha.16"}