vitdoc

Based on Vite, use markdown to write React component documentation, and automatically extract component interface definitions.

Inspired by dumi、Histoire

English | 简体中文

Features

• Vite kernel, efficient and fast development experience.
• Using the Markdown writing, you can quickly write documentation for the project, automatically generate a preview, and generate documents while debugging.
• Automatically analyze TypeScript type definitions and generate API documentation.
• Automatically generate menu navigation based on .md file directory.

Write documentation by markdown

Extract ts interface

Usage & Guide

You can check out the projects in the examples directory for a quick start.

$ npm install -g vitdoc
$ cd ../examples/demo
$ vitdoc

More Details

• [Bilibili] Why do Vitdoc?
• [Article] Increase team performance by doing components
• [Article] Use Vite to make a react component inspiration