Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Make examples interactive #426

Closed
skv-headless opened this issue Mar 13, 2015 · 8 comments
Closed

[docs] Make examples interactive #426

skv-headless opened this issue Mar 13, 2015 · 8 comments
Labels
docs Improvements or additions to the documentation

Comments

@skv-headless
Copy link

I can work on It. I would like to reuse this component
https://github.com/react-bootstrap/react-bootstrap/blob/master/docs/src/ReactPlayground.js

@jkruder jkruder added the docs Improvements or additions to the documentation label Jul 8, 2015
@hai-cea hai-cea changed the title Make examples interactive [docs] Make examples interactive Jul 28, 2015
@oliviertassinari
Copy link
Member

@skv-headless Any update on this? I don't think that it worse the effort.

@oliviertassinari
Copy link
Member

Edit, there is https://github.com/FormidableLabs/component-playground that we could use. Still, what is the use case?

@newoga
Copy link
Contributor

newoga commented Jan 22, 2016

I think this isn't critical but it would be nice to have. Sometime's when you're new to a project it's fun to tinker a bit beyond the examples. Also, it might be useful in terms of reproducing issues. For example, if someone has an issue with how a component is working, we could ask them if they could reproduce it in component-playground on the doc site.

@mbrookes
Copy link
Member

Codepen and JSFiddle both have a post API, which would let you push each example, but they would need a compiled version of each component (or the entire lib) hosted somewhere so that they (or it) could be included.

@newoga
Copy link
Contributor

newoga commented Jan 22, 2016

Mm, I think I like that route. I think supporting codepen / jsdfiddle could go a long way interms of better supporting this project here and on StackOverflow. Getting reproducible examples helps so much when pinpointing root cause of something.

I guess first step is making creating a webpack build of material-ui part of our build process. Maybe after we have that we can see if cdnjs would be willing to host it for us?

@mbrookes
Copy link
Member

Could it not be served from github pages?

@newoga
Copy link
Contributor

newoga commented Jan 22, 2016

Mm...yeah I don't see why that wouldn't work. That idea just reminded me of this option too: https://rawgit.com/

@mbrookes
Copy link
Member

Interesting. And the compiled lib could still live in its own branch if it was desirable not to pollute main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

6 participants