{"_id":"@alisowski/storybook-addon-notes","_rev":"1-a0cb0bf4c1a449071b8fe4c5a2d908c6","name":"@alisowski/storybook-addon-notes","dist-tags":{"latest":"6.0.1"},"versions":{"6.0.1":{"name":"@alisowski/storybook-addon-notes","version":"6.0.1","description":"Write notes for your Storybook stories.","author":{"name":"Andrew Lisowski","email":"lisowski54@gmail.com"},"keywords":["addon","notes","storybook"],"repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/storybook-addon-notes.git"},"license":"MIT","scripts":{"build":"tsc -p tsconfig.json"},"dependencies":{"@storybook/addons":"^6.0.0","@storybook/api":"^6.0.0","@storybook/client-logger":"^6.0.0","@storybook/components":"^6.0.0","@storybook/core-events":"^6.0.0","@storybook/router":"^6.0.0","@storybook/theming":"^6.0.0","markdown-to-jsx":"^6.10.3"},"devDependencies":{"@types/react":"^16.9.49","auto":"^9.52.0","husky":">=4","lint-staged":">=10","prettier":"^2.1.1","typescript":"^4.0.2"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,css,md,ts,tsx}":"prettier --write"},"auto":{"plugins":["npm","released"]},"publishConfig":{"access":"public"},"gitHead":"0e14e19dd76cad194e8b77c1398d977f0b95610f","bugs":{"url":"https://github.com/hipstersmoothie/storybook-addon-notes/issues"},"homepage":"https://github.com/hipstersmoothie/storybook-addon-notes#readme","_id":"@alisowski/storybook-addon-notes@6.0.1","_nodeVersion":"10.22.0","_npmVersion":"6.14.6","dist":{"integrity":"sha512-SQZmbV0vS8ASGzlp0MvCrd1j32mLrL7CftAJesXtkmWF/KZH/ReBiVxqbo6/fLGrr1u2L6nia0RkVe/wU1yFqA==","shasum":"6ac669890f003f1ea499c895b84448616f6f5832","tarball":"https://registry.npmjs.org/@alisowski/storybook-addon-notes/-/storybook-addon-notes-6.0.1.tgz","fileCount":8,"unpackedSize":15066,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfUoF6CRA9TVsSAnZWagAAcDMP+wekto//KUC+aAtiUzPb\nd3Xx9haGNgU82Z94zPntc+22NoWcG82+SwekLjejT/qJ/a5Yj6LZT5sxdnuu\n36g6TFnxJw8SL5E74UNH3f/N5Fb9eay6zNhf1DhBviLBSoRGpDZqzdYwYGFX\nKs28vXnXpTIx6imFp/xrD/YZFp71Z2tSi/NnW9tP3ZdaSKNY+PXWtSjQ3Iuv\nFsCFdG9RkGpgWK7lLL/w6V98+iXd1FvgSOzFUHeaGELyOhEetPAMdexuTp/E\ndBlYjy7aMG+x5RBB3XqAbM84eRHbhPHosskTMl/+1hMOxpSTH6Uq2lVLh8K4\nbcw5nuJPrv5j010ckUsLB+reXuzWr/JA2Qf0UkxTZcvRzorPU3P0uUVrFJVg\ntC4etSr+tu2s/JGmYcjMq5r/MeMIqyi3SwmyraWreKH/OZrvTa/y5hTUPDy2\nYfb0e89CR5X4A2QF/+7Mao7ZoVG65rarYPr8/fpQdYHZqtJttzwGoT7hrTE5\n5ApAuns/pWAHVGzmLfRlZpIvdIVKI7v0dp4DnXsr2+qU7h2MuIgK4JLnNZJI\n8lM8myT5WqqSvFYyVcUoewwhnJoxonq5iIXZEhFOLx1gELoUvwijBAr1zwbz\nPo+SHmH/oOysnkAlnQv4D9xivgU6zt8R2WNwDs6KagKqXtm64RJxr5tdMogo\nSIaA\r\n=ABUU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEsNKS4s/KIEcowDcrWkIBPWxcs92kIDPREWRebZnd2QAiEA57xtgnia0LxSEiWOCLs+yRqnkd4ReQ8hGEMwKMBW/+4="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-addon-notes_6.0.1_1599242618004_0.5655338000507504"},"_hasShrinkwrap":false}},"time":{"created":"2020-09-04T18:03:37.970Z","6.0.1":"2020-09-04T18:03:38.090Z","modified":"2022-04-04T13:27:47.480Z"},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"description":"Write notes for your Storybook stories.","homepage":"https://github.com/hipstersmoothie/storybook-addon-notes#readme","keywords":["addon","notes","storybook"],"repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/storybook-addon-notes.git"},"author":{"name":"Andrew Lisowski","email":"lisowski54@gmail.com"},"bugs":{"url":"https://github.com/hipstersmoothie/storybook-addon-notes/issues"},"license":"MIT","readme":"# @alisowski/storybook-addon-notes\n\n> NOTE: Storybook deprecated this plugin in favor of `addon-docs`.\n> While that plugin is useful this plugin solves different problems.\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/storybookjs/storybook/blob/master/ADDONS_SUPPORT.md)\n\n![Storybook Addon Notes Demo](docs/demo.png)\n\n## Getting Started\n\n```sh\nyarn add -D @alisowski/storybook-addon-notes\n```\n\nwithin `.storybook/main.js`:\n\n```js\nmodule.exports = {\n  addons: [\"@alisowski/storybook-addon-notes/register\"],\n};\n```\n\nAlternatively register the notes addon into a panel. Choose only one, not both.\n\n```js\nmodule.exports = {\n  addons: [\"@alisowski/storybook-addon-notes/register-panel\"],\n};\n```\n\nNow, you can use the `notes` parameter to add a note to each story.\n\n```js\nimport Component from \"./Component\";\n\nexport default {\n  title: \"Component\",\n  parameters: {\n    notes: \"some documentation here\",\n  },\n};\n```\n\n### Upgrading to CSF Format\n\nAdd `notes` to the `parameters` object:\n\n```js\nexport default {\n  parameters: {\n    notes: \"My notes\",\n  },\n};\n```\n\n## Using Markdown\n\nUsing Markdown in your notes is supported, Storybook will load Markdown as raw by default.\n\n```jsx\nimport Component from \"./Component\";\nimport markdown from \"./someMarkdownText.md\";\n\nexport default {\n  title: \"Component\",\n};\n\nexport const withMarkdown = () => <Component />;\nwithmarkdown.story = {\n  parameters: {\n    notes: { markdown },\n  },\n};\n```\n\n## Multiple Notes Sections\n\nIf you need to display different notes for different consumers of your storybook (e.g design, developers), you can configure multiple notes pages. The following will render a tab with unique notes for both `Introduction` and `Design`.\n\n```js\nimport { storiesOf } from \"@storybook/react\";\nimport Component from \"./Component\";\n\nimport intro from \"./intro.md\";\nimport design from \"./design.md\";\n\nexport default {\n  title: \"Component\",\n  parameters: {\n    notes: { Introduction: intro, \"Design Notes\": design },\n  },\n};\n```\n","readmeFilename":"README.md"}