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

Provide documentation generator #11242

Closed
markbrocato opened this issue May 4, 2018 · 2 comments
Closed

Provide documentation generator #11242

markbrocato opened this issue May 4, 2018 · 2 comments
Labels
docs Improvements or additions to the documentation new feature New feature or request

Comments

@markbrocato
Copy link

For those of us building reusable components on top of Material UI, it would be awesome to document our components in the same style as on the Material UI website. What do you use to generate your documentation? Can we use it too?

@oliviertassinari oliviertassinari added new feature New feature or request docs Improvements or additions to the documentation labels May 5, 2018
@oliviertassinari
Copy link
Member

oliviertassinari commented May 5, 2018

@markbrocato I have been thinking about it too! I know Bootstrap provided such tool at some point in its history. This might no longer be true. On the project I'm working on, we started using Storybook for solving this problem.

The implementation will largely depend on how people wrap Material-UI components. If it's a direct mapping, then maybe we can alias the components. For instance, aliasing material-ui/Button with myproject/Button. It's a feature available in webpack. There is no quick-win here. If we want to push this issue forward, we gonna have to dedicate quite some time to it.

@oliviertassinari oliviertassinari added this to the post v1.0.0 milestone May 10, 2018
@oliviertassinari oliviertassinari removed this from the post v1.0.0 milestone Jul 17, 2018
@oliviertassinari
Copy link
Member

I'm giving up on the idea. It didn't have traction.

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 new feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants