{"bugs":{"url":"https://github.com/storybookjs/storybook/issues"},"dist":{"shasum":"c836b1b9a7374f2c830a12030ba69250924c51a2","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-6.0.0-alpha.2.tgz","fileCount":20,"integrity":"sha512-hg98JqgavnARbp8WA77zb5p5YNmMB+Xi+qsc3QxqEiWHdqqtnOJpU9eqs/eJPOHL2Tny49jipDmo7nVFNmOETA==","signatures":[{"sig":"MEUCIQCQSByg8oT1LTnO1n4LPvD7u8eDb8EZr8qLk0ffbngVUQIgFnjN4vZ4typsW/71GXPAoPkRNUTjsOkxDw5nvh0okec=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29189,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeMt0iCRA9TVsSAnZWagAAM7sP/Rrn+LQQoP03cI28N3gl\n3yId3o3Lq/I2wgQaOnQvV7P2In+Q7/qJ0nzHPdOMmiMs0ghVf/XcAN4+TbOI\nvHUDqci0Ynw7GQ4FL5+cmUctRJk9DipUDMYyvFyKMmd0uDVw1cznuZJhrZYl\nHSUsQ/BkKWjDr7RdFJDRFhcjCv5BQdb9kJLDJUYi4mT8GWLRnpwdQAeZm769\nJDfzYVVBRDDHXVBaKxVmUlltmZSd0qs0CtWOn/1Q42u1CWKDiugRx38vo+BD\nXJ/QpNYDjpbJNo18c7ve8ceNK4uk7BWQdX6SRY8DLJNBvh3NS6v68bzpCEva\nJgpfNRawvjomkbZ1LGQCjWqujswYQ43+/kw/3oL57ZEfOeNraZWTJXs+4zFE\na83WUDOT8zwIQAnmlOKqagoXU3rXfZeI38usmKRqeDH1cNR8ZWHMRP0oMF10\nfw9yIReiAAvI0sTAGG31ejlBPBsmS3TZ2KXhacFMz4f10e2jpKkgWp765uoM\nJ++Cgc8RNbYbh16u2XMt/EfWpmawlMXNNpt3bF5TNRkYQsEFfbLqtVdtjVaF\nz3cf1kmMXJctTqt+eXJoxhh5qyaxLbCEcZGQgGYdwiQWK7Ck//d7IV9iW1PZ\nVX1fqRbyyvpt//dgobHdiZPHM5dLdXmSwN3K7xeeXUN1UnorSRvR7zsZlA4g\nC5Ex\r\n=Rk37\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":"779ef4791d9e2ec24cbaccff2e4b9a5f9b0327eb","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":"pago","email":"patrick.gotthardt@trivago.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.2","util-deprecate":"^1.0.2","markdown-to-jsx":"^6.10.3","@storybook/addons":"6.0.0-alpha.2","@storybook/router":"6.0.0-alpha.2","@storybook/theming":"6.0.0-alpha.2","@storybook/components":"6.0.0-alpha.2","@storybook/core-events":"6.0.0-alpha.2","@storybook/client-logger":"6.0.0-alpha.2"},"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.2_1580391714133_0.4285026080709564","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@6.0.0-alpha.2","version":"6.0.0-alpha.2"}