基于 Vite,使用 markdown
编写 React 组件文档,自动提取组件接口定义。
English | 简体中文
Vite
内核,高效极速的开发体验- 使用
Markdown
写法,让你快速为项目编写说明文档的同时,自动生成预览,在调试的同时生成文档 - 自动分析
TypeScript
类型定义并生成 API 文档 - 自动根据
.md
文件目录生成菜单导航
你可以查看 examples
目录下的项目,便于你快速开始使用。
$ npm install -g vitdoc
$ cd ../examples/demo
$ vitdoc