{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"734ba7eb8b744b86f1c1b85f078fc827f326e942","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.9.tgz","fileCount":12,"integrity":"sha512-nju5U4uAg0syqevQ9uh5v8jfXc0E6ZElsvyrEl1SkwOuDMogegEF85Uo+tNSbiAA+sDi7DcK6wGRK02iw8oFIg==","signatures":[{"sig":"MEUCIQC7m/EOKhlspy5NYLDSTHvcRhE5eWyuWIVj0ZrkwInYcwIgTBVQjqlofToFzC6vMjYXxt/h+AX6It4zs3xqKtkCzHM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":177457,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbHNcUCRA9TVsSAnZWagAAwloP/is19ZwVVRqOfL6jKAKo\nfd9pCkqlUkLaHIX9Cb66ETWcrOXWhXePejiDvmE0OcaPQVJPXCGepGY6yBAF\n5UTryEO5wVvvre8sEcKmSlNIPQJZlWVUBO0H5OyGLuHQ1os0SYuJOH5yHG8O\nSL/KUKCszQdAWvAFBQg6sQ9CtqUWD1AGtdTzyPPnaUHhUpXdUNO6J9jLLQv0\nj0/wcyyJGAiOwz/30930hn/7PGwtnR1xi5C0I6ThzTJ00yE1gYNYfGAHDfHq\nO98txkhPN1OUEvgubDHilTANbELtpQmkpes5+DEX9YTXIt1JDSGHDvHuo2A1\nEHxVupVoSWCqKH3rRrK9MJ1HKS4yhD/jS8HUx8sEmXyNynU9KucLGYtOXyvb\nD2XVGEmHwYR+kxNg4v00VxnzS3UiZ1HigbIFo8VXwZwGxo1BvbJa8SQ2+Pro\n2n/BhyGdtJD5GbZun6JRwbqW+COXZ465qGt/joNoypws/rsIqeYNEweKsqgU\nfAE/ctxu60cC2xPcz+D4BaFRyGD2ozw1SZJvvKqj/u4UTf4f4tJgZqG/DFe4\nCHVJUMDbIGFQLzvK0/pTRdku+o50xVzK+WTxmu4EDAh2Y7TJhYzNm/8iVZbQ\n8gyXz9sWATAQXKTGhl7tcR6OvhtcxEm8F7w7iboWOMsYmwLVhmo1d/FpRfss\nCG3X\r\n=cfdr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-notes","readme":"# Storybook Addon Notes\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**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","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":"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":"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.9"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.9_1528616723396_0.17045605542732445","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.9","version":"4.0.0-alpha.9"}