@storybook/addon-notes - npm Package Compare versions

package.json

		{
		"name": "@storybook/addon-notes",
		"version": "3.3.0-alpha.3",
		"version": "3.3.0-alpha.4",
		"description": "Write notes for your Storybook stories.",
		@@ -22,3 +22,3 @@ "keywords": [
		"dependencies": {
		"@storybook/addons": "^3.3.0-alpha.3",
		"@storybook/addons": "^3.3.0-alpha.4",
		"babel-runtime": "^6.26.0",
		@@ -28,7 +28,2 @@ "prop-types": "^15.6.0",
		},
		"devDependencies": {
		"react": "^16.0.0",
		"react-addons-test-utils": "^15.5.1",
		"react-dom": "^16.0.0"
		},
		"peerDependencies": {
		@@ -38,4 +33,4 @@ "react": "*"
		"optionalDependencies": {
		"@types/react": "^15.0.24"
		"@types/react": "^16.0.20"
		}
		}

README.md

		@@ -44,5 +44,19 @@ # Storybook Addon Notes
		storiesOf('Component', module)
		.add('with some emoji', withNotes('A very simple component')(() => <Component></Component>));
		.add('with some emoji', withNotes('A very simple component')(() => </Component>>));
		```

		#### Using Markdown

		To use markdown in your notes simply import a markdown file and use that in your note.

		```js
		import { storiesOf } from '@storybook/react';
		import { withNotes } from '@storybook/addon-notes';
		import Component from './Component';
		import someMarkdownText from './someMarkdownText.md';

		storiesOf('Component', module)
		.add('With Markdown', withNotes(someMarkdownText)(() => <Component/>));

		```
		### Deprecated API
		@@ -49,0 +63,0 @@ This API is slated for removal in 4.0

New alerts