vitdoc
v1.8.9
Published
Seamlessly generate a lightweight, fast and beautiful component documentation.
Downloads
100
Readme
Based on Vite, use markdown
to write React component documentation, and automatically extract component interface definitions.
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