doczjs/docz

Docz is a tool that makes it easy to write and publish documentation for React component libraries and design systems. The problem it solves is that documenting UI components typically requires building a custom documentation site from scratch, a significant time investment that distracts from building the actual product. With Docz, you write documentation files using MDX, a format that mixes regular Markdown prose with React components. This lets you embed live, interactive demos of your components directly into the documentation page. For example, you can write a paragraph explaining a Button component and then show a working, clickable button right next to the text, not just a code snippet. Docz takes those MDX files and automatically generates a complete documentation site with live reloading during development. It is built on top of GatsbyJS, which means the output is a static website that is fast, SEO-friendly, and easy to deploy anywhere, no server required. You would use Docz when you are building or maintaining a React component library or design system and want documentation that is both accurate and interactive. It is particularly useful for teams that want their examples to stay in sync with the real component code, since the examples are the actual components running live. It is written in TypeScript and supports React.