Use react-styleguidist to automate documentation generation

gabrielbull / react-desktop

React UI Components for macOS High Sierra and Windows 10

http://reactdesktop.js.org

MIT License

9.51k stars 462 forks source link

Use react-styleguidist to automate documentation generation #97

Open okonet opened 6 years ago

okonet commented 6 years ago

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 commented 6 years ago

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.