{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"3754722ec272d7fb18ef38c1a7d7825201ed9348","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.2.0-alpha.6.tgz","fileCount":18,"integrity":"sha512-BDh8q4LbZaff4dZCpGb8IQVmjc+SywFS3hxb+SS+PqzXZLHixfUupN+P38Ei8UHufgX+Cl+rysND6sQoGhMnow==","signatures":[{"sig":"MEUCIQC0noxACyvWK0AkZojl0mVg3/BbGmCyyG+ph/nbNvlhGAIgUePEaNKlq1DbDGGbumPhnfL8qowGNEZbNWURitbairM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":179329,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcHBamCRA9TVsSAnZWagAA8RQP+wZXoKkdp7USZh7mctdM\nIssNG7G5Pa89LUH1p24Ris1Tq4sCkY6wq3LqUFCSxPAKejVxyvZLdAE7PomG\n63D419KYZS4dvIe7VvLvTHHg+bHduxpmpkCv9xb9kMjW/msaWGmW5Rx/sSX9\novsj9x+Cc7nAvg+L16ApGy9s9spwGVWfHycqn2rs8RG45FphaeeD/kYDEd+L\nZj+8G/ZNdNpKy65P37P6MeD4IDtXS1C/glY2KoUSxYu6kQWr8BgH3qoAnOa7\nZiurQP9SjEEfVvgPGsti5Q+gUUedsYGJ1ohDiNn6746+Xzz/fSkw0CKGRliq\nXQUTnwfQtz/eu0a3Vvlnq9UsGNCVrh5oaXD06Ct4FXitRAPWpxMe1QMbQNcu\nxkJp2tyOi7YPfD0wYk11TVWqCPO7jJbafINEI4Q/ZGq5oXe/0W3wDiidaPsA\nxvbs+dtxACMeQ0AEU05aFV1Uf7ntuoG3sBlEXRCoUXPTO7a2abgZrw3gHXhr\nrWjtEEx/g60ju0+9z9dvT3QbVlwf6URdT7jo10WcOpku1PSTEn3GBaYZKaiD\n/Bz+E4ym/IoyfrxqqAJtV9eQ2fOqivrrvxFg5qw0qUcwdq4gh3rWRiAi8iOe\n+3xUnQ6GQs8DMPahish2Oui6UcrHDtbLY7/tT+IbSM0v01WQuc8+BNimBgoO\nC/rX\r\n=t7BP\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/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)\n\n![Storybook Addon Notes Demo](docs/demo.png)\n\n### Getting Started\n\n**NOTE: Documentation on master branch is for alpha version, stable release is on [master](https://github.com/storybooks/storybook/tree/master/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).add('with some emoji', () => <Component />, {\n  notes: 'A very simple component',\n});\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('With Markdown', () => <Component />, {\n  notes: { markdown: someMarkdownText },\n});\n```\n","gitHead":"bb9b7b3d5b996ed037001f57ca60bd26ac5c1326","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/public_api.ts","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@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.2","core-js":"^2.5.7","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.2.0-alpha.6"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@types/marked":"^0.5.0","@types/prop-types":"^15.5.7"},"peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.2.0-alpha.6_1545344677078_0.5808986729138517","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.2.0-alpha.6","version":"4.2.0-alpha.6"}