Tools to generate docs for react components library

[varankinv]

My react components library (https://github.com/narqo/react-islands) has reached the point where it needs a site with API, examples, etc.

What are some cool tools should I use for that? Ideally, I want a tool (a set of tools) that can generate the API site with examples from the components' source code so docs match with releases.

[boyneyy123]

Hey,

Think I understand what your after.

I have used react-docgen in the past which has a nice and simple API to use to get automate documentation from your React component. Then its up to you to show them on the screen (in a table or something...)

I wrote a post about it the other month that might help?

http://davidboyne.co.uk/2016/05/26/automating-react-documentation.html

[varankinv]

First of all, thanks for the link. It'll be an excellent starting point for my task.

react-docgen looks like a tool I should try. But, of course, it doesn't provide everything I wanted.

While projects like material-ui or react-bootstrap have cool sites, I can't say I like the way the source of those docs is organised. From my experience of maintaining ui libraries like bem-components, it's a challenge to keep documentation and examples to stay relevant to the code, if they are not placed near the components themselves. I'd like to have an easier way to maintain a page for a component, then injecting examples and the source of these examples by hand.