{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"ed7b621ffef028f0420edb6cf16c9a81d905d161","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-3.4.0-rc.0.tgz","fileCount":15,"integrity":"sha512-rSj2zFg571QJRcSOsB/QfAdZULD2/tgTLFbEsUd7q/AOdw3iEf1VTHSFNmz536wA2sibWfLmADs0/2Y34rBv1w==","signatures":[{"sig":"MEUCIQCqK0TRUIxs7r1ewDrq2SfLwOb01YKrMQilQMTS66rfBwIgaYy/YsZq2fIm4/T6Xf7l89FdrrEOvZnxJtyakmAzj7w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":177202},"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\nnpm i --save-dev @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 write your stories like this:\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport { withNotes } from '@storybook/addon-notes';\n\nimport Component from './Component';\n\nstoriesOf('Component', module)\n  .add('with some emoji', withNotes('A very simple component')(() => </Component>));\n```\n\n#### Using Markdown\n\nTo use markdown in your notes simply import a markdown file and use that in your note.\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport { withNotes } from '@storybook/addon-notes';\nimport Component from './Component';\nimport someMarkdownText from './someMarkdownText.md';\n\nstoriesOf('Component', module)\n  .add('With Markdown', withNotes(someMarkdownText)(() => <Component/>));\n\n```\n\nIf you want to use Github flavored markdown inline, use `withMarkdownNotes`:\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport { withMarkdownNotes } from '@storybook/addon-notes';\nimport Component from './Component';\n\nstoriesOf('Component', module)\n  .add('With Markdown', withMarkdownNotes(`\n# Hello World\n\nThis is some code showing usage of the component and other inline documentation\n\n~~~js\n<div>\n  hello world!\n  <Component/>\n</div>\n~~~\n  `)(() => <Component/>));\n\n```\n\n### Deprecated API\nThis API is slated for removal in 4.0\n\n```js\nimport { WithNotes } from '@storybook/addon-notes';\n\nstoriesOf('Addon Notes', module)\n  .add('using deprecated API', () => (\n    <WithNotes notes=\"Hello\">\n      <BaseButton onClick={action('clicked')} label=\"😀 😎 👍 💯\" />\n    </WithNotes>\n  ));\n```\n","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js","storybook":"start-storybook -p 9010","publish-storybook":"bash .scripts/publish_storybook.sh"},"_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.17","prop-types":"^15.6.1","@types/react":"^16.0.20","babel-runtime":"^6.26.0","util-deprecate":"^1.0.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"@storybook/react":"^3.4.0-rc.0"},"peerDependencies":{"react":"*","@storybook/addons":"^3.3.0"},"optionalDependencies":{"@types/react":"^16.0.20"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_3.4.0-rc.0_1520478232526_0.48334035018760524","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@3.4.0-rc.0","version":"3.4.0-rc.0"}