{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"543b4ecdb3ac46ac77c2a5dc4c65631a711506b9","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.23.tgz","fileCount":13,"integrity":"sha512-g5yZiDXhYqtaoIXTVIWrlOdjvUJfxlq9IUD/4i2pCff0G9vAthyPM2gHDAbaFV59V89GYa4wELw5Q1mEj2NoTQ==","signatures":[{"sig":"MEUCIQD70IeQVO940akoHDI+d/obW5Mo2atIgFtcNrpMeFZgNAIgdxP7OM8qKdEwH3H8HbKJRsUwVzQF/LX+bvH8uiUfQwY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178606,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbqrpNCRA9TVsSAnZWagAAr1EP+wTIApYsBzD4G0b2TV+F\nh4Fh+V7KLwMBW4BnJE2IMtVrkSnHBkZAjAlTx2QBpGB0h5zfetrGZFSd4SWI\ni/pfOE6TP+GqHUavvnVJutPLY1F94QAVdcC1IbCuVaRRb2aZ/2rgDlXmXui1\niWxBHOxCTyudNBX4OVqLq5oICWjTAxSficm/qjor1QFiecTNmgNXoGBWYPWv\nJqMXhVxXhp5Z584guPUiQC2Epv4cCyuQG4yf6eW4IdmQNmXdnkfDpVjYZRoE\nyZqJGvR7x6X9NfxWWpm0Hh4xyE2nutX+2GdY8FRm50pe+JyCyyrCsRyP6tFI\n3wKRNWwOnvorJ3GoZAaek8ac1EqYo3pKE060qq3ZWxG9SLGct1SygzdYV7WQ\nmQP61BhfQ59OMASa5GTysFnwhA2xSgPZf3eaE+uAoeya+9ENTTUTp8FIV/fI\nZ7Fx01PDs3phC4TlooUqLP+4cLAXqunKYPBulw5oc65Wt+lSBmsoGWV7aS5j\nX8BoE+UR4qS3UixudvmxjGF5wkZmP+Ln/ibwqiBrAk1bTO2diWVq2va9WUo4\nc5Bd/Bre9Fnc1pPZSFJuJ3IbanDtXQIXAZAmknjqBwjg1F73tUNbDsQXAaDN\nY3oEo//B4J53PCfENtnUp9UnxaZMfPF1Kw2XTV+5UUnV1zBkSQk0zc7/vA5J\nW83G\r\n=0HdD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-notes","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**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","gitHead":"2ca9c34c4c929109170b01751632858934b1b54d","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":"https://github.com/storybooks/storybook.git","type":"git"},"description":"Write notes for your Storybook stories.","directories":{},"jsnext:main":"src/index.js","maintainers":[{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"christianalfoni","email":"christianalfoni@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":"usulpro","email":"regx@usul.su"}],"dependencies":{"marked":"^0.5.0","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.0.0-alpha.23"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.23_1537915469241_0.2559559899082733","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.23","version":"4.0.0-alpha.23"}