styleguidist/react-styleguidist

Add support for babel-plugin-flow-react-proptypes

Open

#1,271 opened on 2019年2月8日

GitHub で見る
 (3 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

説明

The problem

react-docgen isn't very reliable, and doesn't work at all with styled components.

Proposed solution

Allow to generate the documentation from React PropTypes autogenerated with babel-plugin-flow-react-proptypes starting from the Flow types.

Alternative solutions

Fix react-docgen, but it's not trivial.

Additional context

I think it's a low hanging fruit that will improve the quality of the generated documentation for Flow users. It may even be used as a fallback solution if react-docgen fails.

コントリビューターガイド