{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"c7806e8a350728801f965b503b3d1e5ec6c77df5","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.8.tgz","fileCount":12,"integrity":"sha512-ToreihHOGUV/3TSpTi7S0VlPBVrKAv4mScl6RNBKLMbXfVFy1siSx/Z3L7BxYS1DH4Txa4bb6BPVo5/pOAWIDw==","signatures":[{"sig":"MEUCID6Czc1bSTJ6tdQsJ5DPUWtSN1asxrTLPtTfP0ft3zTeAiEApvIrVzp26J+5fBfYpy0HKxS93da2+sDpdEgvZ1fm+3c=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":177189,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbCg7NCRA9TVsSAnZWagAAzrMQAKBXtLp7r/aYGOpIYSEm\n2svIqlgx2oXmznCqlbYDFYWQzpvRO5gV99em6T4UNb70/Nja6R5kiqsx9Qrm\nbquy1SW0Kz8IksewyF3sn6rZAr9f0vmVomlfg9qXUabIv46T44gZAHS/rML1\nCFYGOe/eauUJVYPcV29WV7BB/1ZBL70ufOYLB6m/NPa10rhxNHaY2p/cxhkG\n1aSdpPE1Umkvor1Xs/TUyTPHhwH63vVgfNomyMeZgE++kaQW0wXiSH2AoFZq\nYTFfrNz3uGEzZWnIdQI0gfb0fE32AJdYnCfsgKQZ3nHkK+F8/guPrq2rS6+g\nDTyZFadA/xHAFMgX2rkDYHz1dpvLLJnyx69fFuW8O0StcBptk8TFSCVgDSrf\ntQe7CYYVgBrIeDlBaPwOR2BieojrY4B2Y5DOo4ezjDESnI8quSJNpstHpbxg\n0g48mdCFq/068NL58DxgaZpc5aC2cVBeHqiqA58qKRsSu9EjKnkcTXLT1xl3\n3eAaYNlsBmzp1GN44LlgovsyzhA7Tni8OILUEyViTZZCm0qiLAkS0vcdvA/1\n7qiCreCEMsMdtIt/zD6hhWFu006wGzfjuB7LDHdXKfdjBEetqLaz2rN9FZLg\nFM+joRu3JbyhIrtRBz8thLqofxlhXtvlh00C6Y19H/gUcmF3ewUFujT3nteb\njGkn\r\n=4vjz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-notes","readme":"# Storybook Addon Notes\n\n[![Build Status on CircleCI](https://circleci.com/gh/storybooks/storybook.svg?style=shield)](https://circleci.com/gh/storybooks/storybook)\n[![CodeFactor](https://www.codefactor.io/repository/github/storybooks/storybook/badge)](https://www.codefactor.io/repository/github/storybooks/storybook)\n[![Known Vulnerabilities](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847/badge.svg)](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847)\n[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)\n[![Storybook Slack](https://now-examples-slackin-rrirkqohko.now.sh/badge.svg)](https://now-examples-slackin-rrirkqohko.now.sh/)\n[![Backers on Open Collective](https://opencollective.com/storybook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/storybook/sponsors/badge.svg)](#sponsors)\n\n---\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```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","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybooks/storybook#readme","keywords":["addon","notes","storybook"],"repository":{"url":"git+https://github.com/storybooks/storybook.git","type":"git"},"_npmVersion":"5.1.0","description":"Write notes for your Storybook stories.","directories":{},"jsnext:main":"src/index.js","maintainers":[{"name":"aaronmcadam","email":"aaron@aaronmcadam.com"},{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"arunoda","email":"arunoda.susiripala@gmail.com"},{"name":"danielduan","email":"dduan@yahoo.com"},{"name":"hypnosphi","email":"talpa@yandex.ru"},{"name":"igor-dv","email":"davydkin.igor@gmail.com"},{"name":"mnmtanish","email":"mnmtanish@gmail.com"},{"name":"mthuret","email":"mlthutrix@gmail.com"},{"name":"ndelangen","email":"ndelangen@me.com"},{"name":"shilman","email":"michael@lab80.co"},{"name":"tvs","email":"teije-vs@hotmail.com"},{"name":"usulpro","email":"regx@usul.su"}],"_nodeVersion":"8.9.0","dependencies":{"marked":"^0.4.0","emotion":"^9.1.3","prop-types":"^15.6.1","babel-runtime":"^6.26.0","react-emotion":"^9.1.3","util-deprecate":"^1.0.2","@storybook/addons":"4.0.0-alpha.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.8_1527385805033_0.5289016104732573","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.8","version":"4.0.0-alpha.8"}