{"bugs":{"url":"https://github.com/storybookjs/storybook/issues"},"dist":{"shasum":"da0eec6b73b91fb0b7cb69abb5acbcabaa47f468","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-5.3.0-rc.1.tgz","fileCount":21,"integrity":"sha512-X4sQUcAkZgyGBbaOz1MKZUZ6vfKUUVftP8WifMXBTuDLTcrzU5qnw4iQrXDA+Wdq6MJJ5pHpBlesEitxXPujzw==","signatures":[{"sig":"MEUCIQDIy47oTSg2gniD5FiuSPdvbvRzDzm7CV6entI48MBc7wIgMGXJOFPXnlK36M0zb6R+mVFyTaZyE5+Z7HpG+OH+BHY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":124286,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeAIe+CRA9TVsSAnZWagAAsGgQAKGDS2H/WIkqTiAfD9K1\nHpEIgvp7oLtsqyh14ZSVsysmy32i9O9kKzEvmPY45bSBB1IbM8hnwGeFMydZ\nnYDjc2F2i9RDa9u6s835SYwGyA7ds75TYs3AuCb7vq9/JsB9qGzgD6/1JPGV\nzARZBSqkZsF+eaJixxPvlNWg6Ic7/nJ2LUhm2a1ozngd7e0SV5Y0V46aW8Cb\nJvSQ1HKym0iVGrFju2wIGY2zG3Jf+ECYkIWaC1xwKGiEr9BpqI1lYNE4bEZx\nTHz4pdpuATeTXf7kkeROXxt1ZXvrOQ6NP6JJCVHBe/QBK/P1qJo2Zp91tswa\nfnr+j2iEmcdVNhR+YftgMVT0w+b06ktRoq/0bAoUBAhtLJRrbNCH6lBRLXZF\nmB8Uc9aL4SyOodww3uSXUzTnDf4IC/e00vH2ueUHtpFSU966Xl9DW0o3Esv4\nWf3CZwkMT25/x8gp0rFStfg67rF/Sn0/2sspu7zwgAaILpR1raRj4lDail60\nTTc/jMoXrT2VJPgqYU+L3fkjRssESlLRMzgZbFy/po7exknyi7s4E2fkVJ2N\n+Af2fUttvr6L/2f9n5VqR+dOia/J85RU633P/puMuyVft2Vww8P2S6TvvyoG\no4YOEiFjPfCoedKpN+f18kzu5OAy03JBNrPSrOESz/I47QyTUl6k3jauhXxb\nYBqO\r\n=20F8\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## 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":"c64a498a62180619dccf905a25346cc3e00247af","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.19.0/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":"5.3.0-rc.1","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.10.3","@storybook/addons":"5.3.0-rc.1","@storybook/router":"5.3.0-rc.1","@storybook/theming":"5.3.0-rc.1","@storybook/components":"5.3.0-rc.1","@storybook/core-events":"5.3.0-rc.1","@storybook/client-logger":"5.3.0-rc.1"},"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-rc.1_1577093053597_0.5883169064839784","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@5.3.0-rc.1","version":"5.3.0-rc.1"}