Vue Docgen CLI
JSON →vue-docgen-cli is a command-line interface tool designed to generate comprehensive Markdown documentation files directly from Vue.js component source code. Built upon the powerful vue-docgen-api, it parses Vue 2 and Vue 3 components (including Composition API with script setup, defineProps, defineEmits, and defineSlots) and extracts their props, events, methods, slots, and other metadata into structured Markdown. The current stable version is 4.79.0, with frequent patch and minor releases often synchronized with updates to vue-docgen-api to maintain compatibility with the latest Vue features. Key differentiators include its highly customizable templating system for output Markdown, support for a configurable `docgen.config.js` file, a watch mode for automatic regeneration, and the ability to integrate with existing build configurations (e.g., Webpack aliases) to correctly resolve component dependencies. It provides a static documentation generation alternative to in-browser style guides.
Traffic · last 30 days ↓25% vs prev 7d
top countries 🇺🇸 United States · 🇨🇦 Canada · HK · 🇮🇳 India · 🇩🇪 Germany