{"bugs":{"url":"https://github.com/storybookjs/storybook/issues"},"dist":{"shasum":"73a67c7d6465354a58c827b202c5e9c360e8dbf3","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-6.0.0-alpha.1.tgz","fileCount":21,"integrity":"sha512-3DLTaePbIo5JpHn5Y9Jw4US+OGlCthsux+pcKJSgrkUj7Hoq58xGe5iE/irYguXXoL8FZZssjmBEsEWhUy+FNA==","signatures":[{"sig":"MEYCIQDMw3WagftGQymJyI2jKaRNluSCOoRZoSzfjnnDtR1LMgIhALHXB1lEA1cDRSLMR52YbWDUYoUh0G9akbNtPX0qrZR9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":124453,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeKZBtCRA9TVsSAnZWagAA+xcQAJywwpFgsGprIzBAvoIu\nbWwfWrm9OlkvNiAJuyU2eRnlYianVCwrH0DH0L2r2jpPKT8tcH4VBRS6Tes1\nyqzk8h1BNEvsm6qZVV5ldH/jh4WmoF691QOg/AxWPb8yRgdoknk6Je9c/NRZ\n/NR1IAlq4N3WGRtCzxVhLSVGdvJIjcSKdOFo3jg9BTRL1RU4EOqbX1Gi3t/S\n4M+53XLnLl6FsrtkqP2J2a8hjoZ7ZcvYIyUreRB7iTDMs7zWHpi0OgB718L1\ndTO9XWXFteynk/d7Oca1iF41nVXQq4R6HwvS2+9gDqs2WeS8/XBm8aPQKza7\nVMfCGAmxFH2gXECJlgt0i3warC0IoKvaTEx1AIIqRwuBa1aQgi4Lc1TgUpOf\noAfy7fusloLPaOwYTAyC4xW5eejjKSIcTbscZ73byGi21Q9tzksAJuXoa0eA\niLJzFW+z1Vm4pS94KhdtT5JWz3Pr6YCBJF7tjtrxZxay0Xd+i4L/PJM8/nde\noL3WTq0bbwvNNjlcxu6caU1KgGcCUrEFl7dNRVXBF5fqL7TfWayk5UjaJB8L\nKCv40J5V/4wHwiydMBFiB1XJn2FuvYl+7BjRJPE8iSxynQlELP0lkK63vpnt\nOZirI4Doxxed3rdw6HG6+gb3xQ0msAjecHDO9A7loTbPyP2vtmfg6c/P4laO\nWUeI\r\n=yx/t\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\n\n## Getting Started\n\n**NOTE: Documentation on `next` 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\nwithin `.storybook/main.js`:\n\n```js\nmodule.exports = {\n addons: ['@storybook/addon-notes/register']\n}\n```\n\nAlternatively register the notes addon into a panel. Choose only one, not both.\n\n```js\nmodule.exports = {\n addons: ['@storybook/addon-notes/register-panel']\n}\n```\n\nNow, you can use the `notes` parameter to add a note to each story.\n\n\n```js\nimport Component from './Component';\n\nexport default {\n title: 'Component',\n parameters: {\n notes: 'some documentation here',\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 Component from './Component';\nimport markdown from './someMarkdownText.md';\n\nexport default {\n title: 'Component',\n};\n\nexport const withMarkdown = () => ;\nwithmarkdown.story = {\n parameters: {\n notes: { markdown },\n }\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\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';\n\nimport intro from './intro.md';\nimport design from './design.md';\n\nexport default {\n title: 'Component',\n parameters: {\n notes: { Introduction: intro, 'Design Notes': design },\n },\n};\n```\n","gitHead":"81cb58e2f0512eba22bdf49cbeb8920bb51be937","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.20.2/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":"ghengeveld","email":"info@ghengeveld.nl"},{"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":"6.0.0-alpha.1","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.10.3","@storybook/addons":"6.0.0-alpha.1","@storybook/router":"6.0.0-alpha.1","@storybook/theming":"6.0.0-alpha.1","@storybook/components":"6.0.0-alpha.1","@storybook/core-events":"6.0.0-alpha.1","@storybook/client-logger":"6.0.0-alpha.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/prop-types":"^15.5.9","@types/webpack-env":"^1.15.0","@types/util-deprecate":"^1.0.0"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_6.0.0-alpha.1_1579782253286_0.6627894906392964","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@6.0.0-alpha.1","version":"6.0.0-alpha.1"}