Created by: just-boris
Since I have checked PR #738 about React-Storybook integration and left some comment about that, I continued my search and have found another option: React-styleguidist.
This tool uses a bit different approach, but it fits better in the Create React App convention-based way.
- All your components will be picked up by some glob expression, like this
'./src/components/**/!(*.test).js' - Components definitions will be analyzed to create API documentation based on PropTypes. (Powered by react-docgen)
- You can add
Readme.mdfor every folder with component, where you can write some documentation about it. And (I really like that part) all code snippets will be compiled and executed. So your documentation is still usable as typical Markdown files, but then you can run styleguide builder to see them in action.
I tried to create an integration between Create React App and React Styleguidist as easy as possible, so it worth trying, any feedback will be appreciated.
Also, there is one more similar tool – Carte-Blanche, but it is provided as Webpack plugin, but as far as Webpack config is not available here for direct changes, it was not possible to test it.