Storybook-readme: html support

Created on 11 Sep 2018  路  11Comments  路  Source: tuchk4/storybook-readme

Hi, are there any plans to support @storybook/html? Or @storybook/polymer?
Thanks.

prepare for next release

Most helpful comment

I forgot to notice to change import path :)

- import { addReadme } from 'storybook-readme';
+ import { addReadme } from 'storybook-readme/html';

All 11 comments

Right now there are no plans to support @storybook/html and @storybook/polymer.
Maybe later in next months.

I would be happy for any help :)

Love the project but I鈥檇 like this too! Currently this line is breaking the build in config.js:

addDecorator(addReadme);

Without that line, everything is fine. But when that function is run, I can see the README at bottom but get this error:

Screen Shot 2019-05-06 at 13 47 05

This is my story:

import { storiesOf } from '@storybook/html';
import markdown from '../src/components/manifold-marketplace/readme.md';

storiesOf('Marketplace', module)
  .addParameters({ readme: { content: markdown, sidebar: markdown } })
  .add('default', () => '<manifold-marketplace></manifold-marketplace>')

I know you said there鈥檚 no plans to support, and I respect that, but posting here in case anyone else has suggestions on what to do.

@dangodev Could you please try 5.0.4-alpha.2+6bd5f8d version.

It should work for sidebar docs but still not for content docs :(

Hm. No I鈥檓 still seeing the same error message. I can see the README just fine in the addons panel; I just can鈥檛 see the component anymore. I should mention I鈥檓 using @storybook/[email protected].

It should work for sidebar docs but still not for content docs :(

No worries! I only wanted it for sidebar anyway 馃檪

I forgot to notice to change import path :)

- import { addReadme } from 'storybook-readme';
+ import { addReadme } from 'storybook-readme/html';

@tuchk4 Awesome!! 馃帀 Works perfectly! 馃檪

What it looks like now: web component up top (StencilJS), readme at bottom.

Screen Shot 2019-05-06 at 15 54 33

@tuchk4 hey just wanted to say been using this for a week and haven鈥檛 found any issues! Works great. Is this ready for a patch release yet? Just curious.

it look like the Stencil version of Storybook (that is built on @storybook/html) doesn't work with this addon 馃槙 from what I can understand, there is no html path or file in this addon

addons-configs-consoleerror

Storybook-Projectsite

@lbrustad try npm install [email protected]+6bd5f8d鈥攖his isn鈥檛 in a main release yet.

I鈥檓 using Stencil myself, but using HTML Storybook (not the Stencil version you mentioned). It works great for me.

didn't see your answer before now, but I've tested it, and it works well! thanks!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mcookdev picture mcookdev  路  3Comments

PaulieScanlon picture PaulieScanlon  路  5Comments

LukyVj picture LukyVj  路  5Comments

tuchk4 picture tuchk4  路  4Comments

ankurkaushal picture ankurkaushal  路  4Comments