Docz: Sharing: good Docz Example

Created on 27 Jan 2019  路  11Comments  路  Source: doczjs/docz

Hey @pedronauck, just wanted to share the docz that I have for my project so that you could add those to a list of sites using docz. https://dfee.github.io/rbx

Cheers

Most helpful comment

@sw-yx my implementation is slightly peculiar, but you can here is a link to <Frame> (my iframe component) -- note that i'm truly copying styles and stylesheets from the root window... and also note that i'm using a polyfill for ie11 (which doesn't support the srcdoc attribute.

Also, I have my <SimplePropsTable> implementation here. Note that I've largely thrown out the withMDX components, and probably will throw the rest of it out at some point. This is because it was difficult to understand how it worked (and there's no TS types!).

All 11 comments

hey! i saw you launch rbx on r/reactjs. nice usage of docz! how was your experience?

@sw-yx pretty good. I actually migrated away from storybook.

That said, I had to build a custom props-table, and a custom Frame component (so that certain pieces of my code would be isolated (in an iframe).

The only point of real improvement, I think, is on theming.

Thanks to the feedback @dfee, btw your site is awesome 馃憦 I'm very busy at the end of the last year and at the beginning of this, but this is changing, so close I'll get more involved with docz again and also get people involved in order to help maintain. We really need this. So, this points that you talked, I saw as very important points too and they're already in my mind.

@dfee maybe if you want to PR in your props-table and Frame customization to either the main docz or to the docs i'd be glad to work with you on it since i'm a docz collaborator now

@dfee good usage of docz! btw, how can i write a demo code that contain state components

@sw-yx my implementation is slightly peculiar, but you can here is a link to <Frame> (my iframe component) -- note that i'm truly copying styles and stylesheets from the root window... and also note that i'm using a polyfill for ie11 (which doesn't support the srcdoc attribute.

Also, I have my <SimplePropsTable> implementation here. Note that I've largely thrown out the withMDX components, and probably will throw the rest of it out at some point. This is because it was difficult to understand how it worked (and there's no TS types!).

@HadeAs I wrote stateful components (in my case, they're typically examples), in separate files... for example: <SimpleModalManager>. Note that I just import that component and use it in a playground, but I explicitly call out that I don't ship those examples in my docs.

@dfee thanks for reply!

Awesome example. Thank you for this. Any way to add things like typography and color pallets? Like it's possible in Catalog

In case anyone hasn't seen this in a related issue thread (https://github.com/pedronauck/docz/issues/574)

An iframe playground component :D https://github.com/zicodeng/docz-iframe-playground

cool. closing this for now. iframe looks cool https://github.com/pedronauck/docz/issues/789

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ssylvia picture ssylvia  路  3Comments

hayk94 picture hayk94  路  3Comments

tsnolan23 picture tsnolan23  路  3Comments

mquandalle picture mquandalle  路  3Comments

mariusespejo picture mariusespejo  路  3Comments