{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"e30953fe4e2fba8059c98c1de2c50d357e7b4e1a","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.25.tgz","fileCount":13,"integrity":"sha512-9t6wtBfNfL9PpAgMKV5bWy/PT6jHgm/aGsau/z+09FmboaEvGUi4UbT634qlHxLaYDL1OiKiSw99IPicTTb6Gw==","signatures":[{"sig":"MEQCIAoVtYAQ3KzrR7HjIgDWL6mfNorRyJOIxMant0sSaHPMAiBzpQTwFAklsGHEN2CE4eZwJwCAxsnNkUIk7yEcQE7Ldg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178538,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbwb2bCRA9TVsSAnZWagAAWnAP/jvCd3QoC00JG+8Ne16i\nsySjF0yhC9LfX4nl6DCvI40n8o3tezh0SHMQ4lKS+hv63pz/CYuJ4ZtJLWeK\nQFqfvC+ReNuRCYSl/zk4RSSQGCVTzE5G59A5M2S2H1Xg5KGmhgR/Ta6dtUXN\npocN+2TcdRSDDVS9nj8zbvRVuT/eAOfSfMpWPwJfqIJd3OCOyJMitCMgb7YF\nRZrvnQKDKd4lAQQZlanfRZr3e0r7faePY9iLy1KPBGD9GJe/0DN+w8jtSDXR\n9OmA8byhRXZG5kxCEaq/oJZtLywp4RZVQMwsaJeDo/6ODVAb1/hdbb3iybwc\nss9W2WTkvXkrSL+DHaAEokvGMtPqGHMp4iCFXi8SFVsRS6q3ykeBfH4DcobV\nYFZU0UNezpl9KVnhqqEE2NBwvSDhMFa7Gf4WKv2yV8tqyKuJ32KzDf5kf5na\n+wj9uosoXCUoUJ5hzol/BDJm2Rgk6GrlwS96K/BiMGt8nR9ENjhVyuLnTT5z\nOz+8HzASTtdR1/Ihf4Q+cmdM5/XqqU7opx1oOL3SVOfxxARrSq1bzm48LbTC\n+jBpU3RQlP7jy/5rhZERkb5Z01C7W6HkvIwALwrYxtetRTlCrq3uJQ2CF68p\nXi/gDwMCqoNPyArMXU3edqiZiB3sADSnKMi0PD+Du4w1n7vbzUUeyB62KeZ/\nlvNd\r\n=ISe7\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":"155afad695926070cc6426e98d795907846f1207","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-alpha.25"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.25_1539423642330_0.2690517649042281","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.25","version":"4.0.0-alpha.25"}