{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"72911f34b3cf22a6b7a19aa0f21bcf09803f783c","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.6.tgz","fileCount":12,"integrity":"sha512-HEQP5gp7Maai5eql85MBaxJm24bBSMLRLrgDBmbm/n2KtUCwZelzxnm4GSNFF4M9GcFgVZn4CClGj4cX4wPa6Q==","signatures":[{"sig":"MEUCIQCLs4937gop5mcH9/bWvX30jz05NaccErwBbsQmiYLrhwIgY6otYD86WDSxWksVehy6ic+OFhpq4Gar53AO6F+aZqM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":177713,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa91ATCRA9TVsSAnZWagAAHkAP/39FK8/VUTdrQfUhLBr8\n1i7cfDicvJAV2+Mxeg0uqQpXaLEd3y2E44NmmjT/AudnrOJWOBSJtv/uU8kA\n32AQxn1ZtoXmggaFS4iTuK0UDeiaQsW3k6OrtuxcrvVoj8w4J6kmwuJMc0dg\nZ016bx+yMHU3lpLHJ7EWESyjtlKxUjYP2vNoN2TBuDIOYZ8bxGEmA711TIwG\ntn/uMHWl+P0hxcuDjpr77s7h/62oDm40ZWNUOpfLihPoOcvQ7BvWj+c1aCP8\nv5GAlo7d6QsnvhxteAyJiykAc6Hg21PTWfzGMTM3x6vWJfd2X8MEjq083FJw\nSe2ZD6K+4zl4pbsC4Js10Xyesglp/L1BEC4MRD5lA9NfR2gCCRRr2b6sHOxK\nUV3sTi34zrB1giWcT3iq84iJbhXaorA+zj5khKfc0toJ9MPNfgUNed/d3eh9\nStbvr2cYFI1ytueSX9KfzCL17KZmFbBWNbZzc2timoJCWt7H7+KGLIWuqMNZ\nW99Zt3gHNito6WB8UJu64ifrc8ergahyekim0RmlaEiDXuqKSm5W7olsaAKH\n+lTFMyJBzBILT2TQVSD30H7y7BMJ8fCJjLz6ix8PXY7tq5LCPVtV8FFT+2sp\nN7JLPhWmuy4d7zF7W4IH1dD7/b/QQyysdavd3FvnI+GvxucJ7bimVqgqx1X5\nW/m5\r\n=Sa7j\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.3.19","prop-types":"^15.6.1","babel-runtime":"^6.26.0","util-deprecate":"^1.0.2","@storybook/addons":"4.0.0-alpha.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.6_1526157331187_0.115454473683692","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.6","version":"4.0.0-alpha.6"}