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

Use react-styleguidist to automate documentation generation #97

Open
okonet opened this issue Oct 6, 2017 · 1 comment
Open

Use react-styleguidist to automate documentation generation #97

okonet opened this issue Oct 6, 2017 · 1 comment
Assignees
Milestone

Comments

@okonet
Copy link
Collaborator

okonet commented Oct 6, 2017

react-styleguidist is a styleguide generator for React components that I've been contributing and using for react-dropzone successfully. It automatically generates documentation based on propTypes so there is no need to keep those readme's in sync with code.

It's customizable enough to make it fit any needs but even the default theme is looking gorgeous IMO.

Would you consider switching to it?

@gabrielbull
Copy link
Owner

Hi okonet. I am open to switching to react-styleguidist as an alternative to generating documentation by hand. Let me know if you want to take on this milestone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants