{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"f6b26210d15b4ec0d9310bada8fd7aaa8cb892d7","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.1.0-alpha.12.tgz","fileCount":13,"integrity":"sha512-1J8tjAgw/PiT6f0o8y59LoYsiKVRO13dG1oURm67OSWco/vlNyx4DPEJ8auoxxHyYKSEtdImOzA3kp8fVZt4vQ==","signatures":[{"sig":"MEQCIGD5fkYRwbS7dnb4dCzq1+UkHg6eKMH+nSPiaGv/XOjwAiAlGL3cjXnMZXTBPQoI9Yz8DfS0wVyETHhWWtIyjVroZQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":183513,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcD/TACRA9TVsSAnZWagAA/qQP/0aWDXn5nrGPwFkAAO75\ncVIEhTtK4K9Qb8pj8cz33gVZU2IPFscXNEjUp5IfCHlH6G0wIGF77FJK1skE\ndU4B0HfS0Z06+UwNSPrwcbVanhadBtM+YhzAl/iJqUPIXW65vE1OBp3C0jAP\nUO2RdfR5pBqHDhEz9SZdeYAlsy4sTMxLzWkJ1PTeCS7ewpKJI36sI9njQylu\n5h1SYw/jprb0fxHGdVB8GExu+ukBPf6bm7zWD+en1pybnTzTDtj5xnHVNSHr\nLU9lRMYSbzB3Fl5CJ2XpF1hJUTa6G6DIrA6wD0j47+wmrbxK11mYq5bb9hDQ\nTovfKxNxOk1umEUSasi1p6YnOMj5dK9t+VY6D2Fdj8NVTqT1dvJn1CbuqBXp\ndXyi0+EwgMk363B1kxChnoh5rI+ZhY3/gpP+lVd9VOM40GEYrb9d7503VKOu\nJopTWANtv3ccIoPmsiayORaAL2RD9fj7ckvhFl1J5T3GqoYXaKi4UJe3mSVV\npwTW2vvqX0QEfRkhlOex1BpJaRjephap/IgQDY1KPkkKFhU45+gr+xjf8qoc\nDJlaiXUFn5rY95c0uvq0CXJQTlISOpzvU8C4DMLiUV42T1c5xTBxa0ZyZo8k\nG0lU412mZu3nM1kyaZLKRERmSedBNzqkg4bgZ08lWpDnj1l05rZ4VAYQhmT3\nHJ1L\r\n=SkRx\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\n**NOTE: Documentation on master branch is for alpha version, stable release is on [master](https://github.com/storybooks/storybook/tree/master/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).add('with some emoji', () => <Component />, {\n  notes: 'A very simple component',\n});\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('With Markdown', () => <Component />, {\n  notes: { markdown: someMarkdownText },\n});\n```\n","gitHead":"4ed93b4baf960fb7d614d55dec7981854cc844ac","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":"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":"tmeasday","email":"tom@thesnail.org"},{"name":"usulpro","email":"regx@usul.su"}],"dependencies":{"marked":"^0.5.1","prop-types":"^15.6.2","@emotion/styled":"^0.10.6","@storybook/addons":"4.1.0-alpha.12"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.1.0-alpha.12_1544549567556_0.8163984254439673","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.1.0-alpha.12","version":"4.1.0-alpha.12"}