Based on [Vite](https://github.com/vitejs/vite), use `markdown` to write React component documentation, and automatically extract component interface definitions. Inspired by [dumi](https://github.com/umijs/dumi)、[Histoire](https://github.com/histoire-dev/histoire) English | [简体中文](./README_CN.md) ## 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. ```bash $ npm install -g vitdoc $ cd ../examples/demo $ vitdoc ``` ## More Details - [[Bilibili] Why do Vitdoc?](https://www.bilibili.com/video/BV1ad4y1A773/) - [[Article] Increase team performance by doing components](https://juejin.cn/post/6971244304828203021) - [[Article] Use Vite to make a react component inspiration](https://juejin.cn/post/6844904065684652045)