{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"207799469d6e9063e5aa98fa517b00860906221d","tarball":"https://registry.npmjs.org/@storybook/addon-notes/-/addon-notes-4.0.0-alpha.16.tgz","fileCount":12,"integrity":"sha512-PX4/0G4dwFG+0iz3rndpLhncCw8Pp5jV2iOjwLawo3jDL98Tl3pNsgBtTIfEZY65Lx5zUO1bnKLDxxQ005xZDA==","signatures":[{"sig":"MEUCIQCl0HNNAsAlS7CXuhBldUYvr0h0H0fAjZ3Q5UKQW1MI0gIgCLz9rz8+nAgqtKp0rvZkwu8RFo+j7kFcC0fpiZY4tO8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":176766,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbaFuDCRA9TVsSAnZWagAAokMP/2zpLDaEYYqNcoXA5F/M\nkZY4rMNiN6+VPG5EUjtn6qy/VMbUYaSo1INgtnztHEfHsO1eEO8v6ooP5YHg\nUpSbX1X+WW6LSAeZfanUYwkoC9/v5vdK9ukzbaXzP7KsqGlqK3GUG70h0OJf\n6H2g6KajtP2P1D3n9WGH73roCnkb2X2na8PFXK7Y6M2EB2ZbA6b3vX5eM5iC\n8Z16/+PLchB/nAnHDaOcrs0Ct3ciPpl9DPvs14YbciqemPuMsHWZKKjYfI2o\nRgb4+k8BqVhmQt8lEhiGgW1ibNstOYLWKGghjHe/aFPbwIFLmhuBa0RZeVEF\nKaga8TZSdFW181rm7SV1rFarPZemfgt4K5K16nUbqWma5/HbzhwvjtE496MB\nsHkdgpboLGm1d22evg8cXp/7r79qgGOT7i6o+2SYOH3dgH7WvZK4zRnN/+Ya\nZP1RZGvf6Y8K6POGNsxuYRsO9gOGhAL4cnjiIzVcy1z70v7+1eUYOZEaXboS\nvgAIMTuFvIZgP4FsosdD3GPm0gAH7OnDM/LhD7ddszNJ98ZFuRrUgXRz/3ee\nUo6kRQ65XXJtxfJ3bDYiCujmruj3/ViDH3MZJMyAYo2WaLntJE30l/HV42Jo\nfeGk8FifwT34opZ8ApyjoTS5f9tbGvU7P3h9CUjgzTc8JK4kIEZaVQ7IXFnI\n0In9\r\n=je8n\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","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.11.2","dependencies":{"marked":"^0.4.0","prop-types":"^15.6.2","babel-runtime":"^6.26.0","react-emotion":"^9.2.6","@storybook/addons":"4.0.0-alpha.16"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-notes_4.0.0-alpha.16_1533565826853_0.3843521398917027","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-notes@4.0.0-alpha.16","version":"4.0.0-alpha.16"}