@storybook/addon-notes - npm Package Compare versions

Comparing version 3.4.0-alpha.8 to 3.4.0-alpha.9

dist/index.js

@@ -6,3 +6,3 @@ 'use strict';
 });
-exports.withNotes = undefined;
+exports.withNotes = exports.withMarkdownNotes = undefined;
 
@@ -17,2 +17,6 @@ var _utilDeprecate = require('util-deprecate');
 
+var _marked = require('marked');
+
+var _marked2 = _interopRequireDefault(_marked);
+
 var _react = require('./react');
@@ -22,2 +26,14 @@
 
+var withMarkdownNotes = exports.withMarkdownNotes = function withMarkdownNotes(text) {
+  var channel = _addons2.default.getChannel();
+
+  return function (getStory) {
+    return function (context) {
+      // send the notes to the channel before the story is rendered
+      channel.emit('storybook/notes/add_notes', (0, _marked2.default)(text));
+      return getStory(context);
+    };
+  };
+};
+
 var withNotes = exports.withNotes = function withNotes(textOrOptions) {
@@ -24,0 +40,0 @@ var channel = _addons2.default.getChannel();

package.json

 {
   "name": "@storybook/addon-notes",
-  "version": "3.4.0-alpha.8",
+  "version": "3.4.0-alpha.9",
   "description": "Write notes for your Storybook stories.",
@@ -24,5 +24,9 @@ "keywords": [
     "babel-runtime": "^6.26.0",
+    "marked": "^0.3.16",
     "prop-types": "^15.6.0",
     "util-deprecate": "^1.0.2"
   },
+  "devDependencies": {
+    "@storybook/react": "^3.4.0-alpha.9"
+  },
   "peerDependencies": {
@@ -29,0 +33,0 @@ "@storybook/addons": "^3.3.0",

README.md

@@ -6,3 +6,3 @@ # Storybook Addon Notes
 [![Known Vulnerabilities](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847/badge.svg)](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847)
-[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)  
+[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
 [![Storybook Slack](https://now-examples-slackin-rrirkqohko.now.sh/badge.svg)](https://now-examples-slackin-rrirkqohko.now.sh/)
@@ -15,6 +15,3 @@ [![Backers on Open Collective](https://opencollective.com/storybook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/storybook/sponsors/badge.svg)](#sponsors)
 
-This addon works with Storybook for:
-- [React](https://github.com/storybooks/storybook/tree/master/app/react)
-- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
-- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
+[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)
 
@@ -63,2 +60,26 @@ ![Storybook Addon Notes Demo](docs/demo.png)
 ```
+
+If you want to use Github flavored markdown inline, use `withMarkdownNotes`:
+
+```js
+import { storiesOf } from '@storybook/react';
+import { withMarkdownNotes } from '@storybook/addon-notes';
+import Component from './Component';
+
+storiesOf('Component', module)
+  .add('With Markdown', withMarkdownNotes(`
+# Hello World
+
+This is some code showing usage of the component and other inline documentation
+
+~~~js
+<div>
+  hello world!
+  <Component/>
+</div>
+~~~
+  `)(() => <Component/>));
+
+```
+
 ### Deprecated API
@@ -65,0 +86,0 @@ This API is slated for removal in 4.0

src/index.js

 import deprecate from 'util-deprecate';
 import addons from '@storybook/addons';
+import marked from 'marked';
 import { WithNotes as ReactWithNotes } from './react';
 
+export const withMarkdownNotes = text => {
+  const channel = addons.getChannel();
+
+  return getStory => context => {
+    // send the notes to the channel before the story is rendered
+    channel.emit('storybook/notes/add_notes', marked(text));
+    return getStory(context);
+  };
+};
+
 export const withNotes = textOrOptions => {
@@ -6,0 +17,0 @@ const channel = addons.getChannel();

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

177208

increased by0.95%

Lines of code

339

increased by10.42%

Number of lines in readme file

95

increased by28.38%

Worsened metrics

Dependency count

7

increased by16.67%

Dev dependency count

1

increased byInfinity%

Dependency changes

• + Addedmarked@^0.3.16

• + Addedmarked@0.3.19(transitive)