{"repo":"vitdocjs/vitdoc","free":true,"listed":false,"github":"https://github.com/vitdocjs/vitdoc","clone":"git clone https://github.com/vitdocjs/vitdoc.git","description":"Use markdown to write documentation, and automatically extract interface definitions.","language":"TypeScript","stars":83,"topics":["markdown","react","typescript"],"license":null,"category":"dev-tools","readme_excerpt":"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. 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)","default_branch":null,"files":null,"tree":[],"storefront":"/r/vitdocjs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/vitdocjs/vitdoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}