{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"316f7b641fd439357bfd8894185f2480391b6fdb","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.2.0-alpha.11.tgz","fileCount":17,"integrity":"sha512-QeCIDh8haiiAkeLrfIRaHn2pzIbMaZfNUfr1W4sFT8woCc0gaZqE/M1w7QaLOMtnYw1opOqrKKnMJ+FtR5LGgA==","signatures":[{"sig":"MEUCIQD/0PRhoICo7BwKOv48aiGSZ4DW98UFvTN/I1gUtpRYzQIgPXKX5SEpLXL9SVBfHI6dkkFibwW/OKi+0LQ+vXCZdNM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":176492,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcNceGCRA9TVsSAnZWagAA3i0P/jyGbImJHdSqD4HvrkMM\n3TMU+ClaiMwFafpO1B9KzhG59zhXtJ8oT41lfF+N33dXO6uQJcdfDpEGbxid\nSBwyQ4zB96nIPohewZghVU/o7ZmQUurw2kABFUV4o5OwQfGuNoCCg3hghJSK\nmeuQWMEjLGbNZobXJoIxALVD5kK0TPMJtuizRKq65PO9K7Mczl6GkveBxQlq\niZyOMTeWbXwEsuw2LMKl3Uu6tN+vwubDO9/Yl8eiSVEP/iwFY9Dka6CV96yV\n4cou4vdQm3nOaD+JjW8TEL0A9RBtHOEXwGnQb2JKlSYobcvKDI8iycESBJPF\n5e0pjBc3+Jj1b7yZhc3ePnZrgQbHZ4lCmZdL6tzMrKhH1wL3SU9Unyw9YU3c\nbbsDF3SC2dS2Gd1W6Vu+ZzHWdsCRpyDYIgzNocfSUNOUdjGugwuKU14djXGa\nUzXD3p0l6XLTJEwc5pGG98DgaFwP7uTBtj9P1HOcEbC7IYDtnIRauV6bUL1y\nIKmuG+EeMyxHEAcH/0MdBdVcx3doAe8XkJB+yiKtOGS6uKUdALRbUT6xwzIz\nxEVHLr3sJBSNafKWJVdFzvE/2jdCc+Tm2KbkdjfHgFb1bU9Bwx/2XREYR/3y\n0M7ghxeGJgjIzDPbiaV9TE7F115DDB+jBhIAvJ+I33L3q5Ooa+dbIbkX8bHq\nCcvo\r\n=O/U6\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":"edcb85f861a178dc47330c911ad658118659f8bc","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":"git+https://github.com/storybooks/storybook.git","type":"git"},"_npmVersion":"lerna/3.8.4/node@v8.11.2+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":"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"}],"_nodeVersion":"8.11.2","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.11","@storybook/channels":"4.2.0-alpha.11"},"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.11_1547028357929_0.8996239917849134","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.2.0-alpha.11","version":"4.2.0-alpha.11"}