{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"406f4a7cfc3b6b7db94949f4a0af1dcd8efe8cc1","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-rc.0.tgz","fileCount":13,"integrity":"sha512-nZexPzQhUa8ULeYsVDRzRHjoF5TmLr+PbQY14fqE+kSZ+UmAK8zDO7+renR7xEbUMdHcE6U5+nICHv//4n3tOQ==","signatures":[{"sig":"MEUCIQDVR3PGwmtFNdIM4dWDPFWSrq1s49v9StY9LqhzbbL++wIgRyGiv/lJpFv9EPR9uJ4LBi7WYXd8nkC7u5Yuz0N6Imw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178530,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbxLWwCRA9TVsSAnZWagAAW3AP/1JwdUOyo6G0I1Mck2BA\nv+l3dn2oWU8vYs3N1r1gla6jK1ADdfchANdNBsNMyXK79jgArYf5a2MYcvrd\nDaYGWgkADvQPxWCz6wCOPBWX+SLyC1yXsE2Z1MdqcnaQws1JEwx6m2t1Zvmp\n7cN7jfnFacFtbE5nCyj+PG/cMj/m5zoVkNyqtEwLV8xdRcMo6hUCdgnyVjzl\nqhLxWh7IWYo1imG2UgnDkQa4A33IDXFHjQuc+otFwpMn3NXgP+zes+BydGRS\neoRSR5Slhvz7pcUcczjuWRQvQFOmiThEP+7b83ttPR7eg1ByAfzvIGEqg0Wt\nqOU3aW3gpW5oxdOc9bwoz5QhBv3LNflQPQ8dVLaFNz8lU5ZY988kN9UQTs0h\nu+fCMU6two4zAVGU3m12ZLinsQCxceIPpaxf74DsfJuuyM9POLj+EC1LuuB5\nyX8TVQy0iKkgn3DMSnJNE/UWVlOiC7QddiYb5uvDfnjE19BPnB42/Ws6w6Od\nKZhIiBZUbOjfmXiZJk9i9yJbofzjCxL3d+zCWBwxFrgP5KHxF1sv7tfSdkp1\np1yl5Gx/ye40qWIsMdh5CF4ZVa9nhvjLPmR1LdIWucnddm+xZzzPrNDi7saM\nsvhXhDlnPJbDpevC7AoKz7RHwfen6RWRuBXY/c1Y7+w0w6xcwgj5L5MDBBG3\n3kut\r\n=5JQ1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-notes","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**NOTE: Documentation on master branch is for alpha version, stable release is on [release/3.4](https://github.com/storybooks/storybook/tree/release/3.4/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\nimport '@storybook/addon-notes/register';\n```\n\nThen add the `withNotes` decorator to all stories in your `config.js`:\n\n```js\n// Import from @storybook/X where X is your framework\nimport { configure, addDecorator } from '@storybook/react';\nimport { withNotes } from '@storybook/addon-notes';\n\naddDecorator(withNotes);\n```\n\nYou can use the `notes` parameter to add a note to each story:\n\n```js\nimport { storiesOf } from '@storybook/react';\n\nimport Component from './Component';\n\nstoriesOf('Component', module)\n  .add('with some emoji', () => <Component />, { notes: 'A very simple component' });\n```\n\n#### Using Markdown\n\nTo use markdown in your notes, either through import or inline, simply put it in the `markdown` property of your note.\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport Component from './Component';\nimport someMarkdownText from './someMarkdownText.md';\n\nstoriesOf('Component', module).add(\n  'With Markdown',\n  () => <Component />,\n  { notes: { markdown: someMarkdownText } }\n);\n```\n","gitHead":"76b3c817a1906759f75ffa91f8261faeb64855df","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":"https://github.com/storybooks/storybook.git","type":"git"},"description":"Write notes for your Storybook stories.","directories":{},"jsnext:main":"src/index.js","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"christianalfoni","email":"christianalfoni@gmail.com"},{"name":"danielduan","email":"dduan@yahoo.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"}],"dependencies":{"marked":"^0.5.1","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.0.0-rc.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-rc.0_1539618223677_0.1533673594890348","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-rc.0","version":"4.0.0-rc.0"}