leonardomso/docz

Docz is a tool that helps you create documentation websites for your code projects with almost no setup. If you've ever built a software component, like a button or a form, and wanted to show your team how it looks and works, this tool turns that desire into a live, interactive web page. You write your documentation in a format called MDX, which is essentially standard markdown text mixed with real, working code components. Instead of manually building a separate website to display your docs, you simply add a file to your project, run a single command, and the tool generates a polished documentation site for you. It updates live as you make changes, so there's no need to refresh or rebuild constantly. This is aimed at developers and teams building design systems or shared component libraries. For example, if your company has a set of reusable UI pieces like dropdowns, modals, and buttons, you can use this tool to create a catalog where designers and other developers can see each piece in action, read about its properties, and even interact with it before using it in their own work. The project prioritizes simplicity and speed. It requires zero configuration to get started, which means you don't need to spend hours tweaking settings before you can write your first doc page. It also supports customization through themes and plugins, so if you need your documentation to match your company's visual style or handle specific file types like Sass or SVG, you can extend it. It's built with TypeScript and offers full type support, which is helpful for projects that rely on strict code typing.