Based on Vite, use markdown to write React component documentation, and automatically extract component interface definitions.
English | 简体中文
Vitekernel, efficient and fast development experience.- Using the
Markdownwriting, you can quickly write documentation for the project, automatically generate a preview, and generate documents while debugging. - Automatically analyze
TypeScripttype definitions and generate API documentation. - Automatically generate menu navigation based on
.mdfile directory.
You can check out the projects in the examples directory for a quick start.
$ npm install -g vitdoc
$ cd ../examples/demo
$ vitdoc